Skip to content

Commit c659afa

Browse files
authored
Rename CreateCrossSigningDialog to InitialCryptoSetupDialog (#28658)
* Rename CreateCrossSigningDialog to InitialCryptoSetup because it will soon encompass things other than just creating cross signing. * Fix name & tests * Fix import * Remove code creating key backup Because this was split out from my key backup by default PR * Fix comment * Convert to named export
1 parent 9cc5564 commit c659afa

File tree

3 files changed

+23
-19
lines changed

3 files changed

+23
-19
lines changed

src/components/structures/auth/E2eSetup.tsx

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,7 @@ import { MatrixClient } from "matrix-js-sdk/src/matrix";
1111

1212
import AuthPage from "../../views/auth/AuthPage";
1313
import CompleteSecurityBody from "../../views/auth/CompleteSecurityBody";
14-
import CreateCrossSigningDialog from "../../views/dialogs/security/CreateCrossSigningDialog";
14+
import { InitialCryptoSetupDialog } from "../../views/dialogs/security/InitialCryptoSetupDialog";
1515

1616
interface IProps {
1717
matrixClient: MatrixClient;
@@ -25,7 +25,7 @@ export default class E2eSetup extends React.Component<IProps> {
2525
return (
2626
<AuthPage>
2727
<CompleteSecurityBody>
28-
<CreateCrossSigningDialog
28+
<InitialCryptoSetupDialog
2929
matrixClient={this.props.matrixClient}
3030
onFinished={this.props.onFinished}
3131
accountPassword={this.props.accountPassword}

src/components/views/dialogs/security/CreateCrossSigningDialog.tsx renamed to src/components/views/dialogs/security/InitialCryptoSetupDialog.tsx

Lines changed: 14 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -25,21 +25,27 @@ interface Props {
2525
}
2626

2727
/*
28-
* Walks the user through the process of creating a cross-signing keys. In most
29-
* cases, only a spinner is shown, but for more complex auth like SSO, the user
30-
* may need to complete some steps to proceed.
28+
* Walks the user through the process of creating a cross-signing keys.
29+
* In most cases, only a spinner is shown, but for more
30+
* complex auth like SSO, the user may need to complete some steps to proceed.
3131
*/
32-
const CreateCrossSigningDialog: React.FC<Props> = ({ matrixClient, accountPassword, tokenLogin, onFinished }) => {
32+
export const InitialCryptoSetupDialog: React.FC<Props> = ({
33+
matrixClient,
34+
accountPassword,
35+
tokenLogin,
36+
onFinished,
37+
}) => {
3338
const [error, setError] = useState(false);
3439

35-
const bootstrapCrossSigning = useCallback(async () => {
40+
const doSetup = useCallback(async () => {
3641
const cryptoApi = matrixClient.getCrypto();
3742
if (!cryptoApi) return;
3843

3944
setError(false);
4045

4146
try {
4247
await createCrossSigning(matrixClient, tokenLogin, accountPassword);
48+
4349
onFinished(true);
4450
} catch (e) {
4551
if (tokenLogin) {
@@ -58,8 +64,8 @@ const CreateCrossSigningDialog: React.FC<Props> = ({ matrixClient, accountPasswo
5864
}, [onFinished]);
5965

6066
useEffect(() => {
61-
bootstrapCrossSigning();
62-
}, [bootstrapCrossSigning]);
67+
doSetup();
68+
}, [doSetup]);
6369

6470
let content;
6571
if (error) {
@@ -69,7 +75,7 @@ const CreateCrossSigningDialog: React.FC<Props> = ({ matrixClient, accountPasswo
6975
<div className="mx_Dialog_buttons">
7076
<DialogButtons
7177
primaryButton={_t("action|retry")}
72-
onPrimaryButtonClick={bootstrapCrossSigning}
78+
onPrimaryButtonClick={doSetup}
7379
onCancel={onCancel}
7480
/>
7581
</div>
@@ -95,5 +101,3 @@ const CreateCrossSigningDialog: React.FC<Props> = ({ matrixClient, accountPasswo
95101
</BaseDialog>
96102
);
97103
};
98-
99-
export default CreateCrossSigningDialog;

test/components/views/dialogs/security/CreateCrossSigningDialog-test.tsx renamed to test/components/views/dialogs/security/InitialCryptoSetupDialog-test.tsx

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -12,14 +12,14 @@ import { mocked } from "jest-mock";
1212
import { MatrixClient } from "matrix-js-sdk/src/matrix";
1313

1414
import { createCrossSigning } from "../../../../../src/CreateCrossSigning";
15-
import CreateCrossSigningDialog from "../../../../../src/components/views/dialogs/security/CreateCrossSigningDialog";
15+
import { InitialCryptoSetupDialog } from "../../../../../src/components/views/dialogs/security/InitialCryptoSetupDialog";
1616
import { createTestClient } from "../../../../test-utils";
1717

1818
jest.mock("../../../../../src/CreateCrossSigning", () => ({
1919
createCrossSigning: jest.fn(),
2020
}));
2121

22-
describe("CreateCrossSigningDialog", () => {
22+
describe("InitialCryptoSetupDialog", () => {
2323
let client: MatrixClient;
2424
let createCrossSigningResolve: () => void;
2525
let createCrossSigningReject: (e: Error) => void;
@@ -43,7 +43,7 @@ describe("CreateCrossSigningDialog", () => {
4343
const onFinished = jest.fn();
4444

4545
render(
46-
<CreateCrossSigningDialog
46+
<InitialCryptoSetupDialog
4747
matrixClient={client}
4848
accountPassword="hunter2"
4949
tokenLogin={false}
@@ -61,7 +61,7 @@ describe("CreateCrossSigningDialog", () => {
6161

6262
it("should display an error if createCrossSigning fails", async () => {
6363
render(
64-
<CreateCrossSigningDialog
64+
<InitialCryptoSetupDialog
6565
matrixClient={client}
6666
accountPassword="hunter2"
6767
tokenLogin={false}
@@ -78,7 +78,7 @@ describe("CreateCrossSigningDialog", () => {
7878
const onFinished = jest.fn();
7979

8080
render(
81-
<CreateCrossSigningDialog
81+
<InitialCryptoSetupDialog
8282
matrixClient={client}
8383
accountPassword="hunter2"
8484
tokenLogin={true}
@@ -95,7 +95,7 @@ describe("CreateCrossSigningDialog", () => {
9595
const onFinished = jest.fn();
9696

9797
render(
98-
<CreateCrossSigningDialog
98+
<InitialCryptoSetupDialog
9999
matrixClient={client}
100100
accountPassword="hunter2"
101101
tokenLogin={false}
@@ -113,7 +113,7 @@ describe("CreateCrossSigningDialog", () => {
113113

114114
it("should retry when the retry button is clicked", async () => {
115115
render(
116-
<CreateCrossSigningDialog
116+
<InitialCryptoSetupDialog
117117
matrixClient={client}
118118
accountPassword="hunter2"
119119
tokenLogin={false}

0 commit comments

Comments
 (0)