From 902aea8bc43a6dcebe53dc465b326502ae573b4f Mon Sep 17 00:00:00 2001 From: Richard van der Hoff <1389908+richvdh@users.noreply.github.com> Date: Thu, 21 Sep 2023 20:34:10 +0200 Subject: [PATCH] LogoutDialog: Remove usage of deprecated keybackup API (#11645) * tests for LogoutDialog * LogoutDialog: Remove usage of deprecated keybackup API --- src/components/views/dialogs/LogoutDialog.tsx | 246 +++++++++++------- .../views/dialogs/LogoutDialog-test.tsx | 84 ++++++ .../__snapshots__/LogoutDialog-test.tsx.snap | 237 +++++++++++++++++ 3 files changed, 468 insertions(+), 99 deletions(-) create mode 100644 test/components/views/dialogs/LogoutDialog-test.tsx create mode 100644 test/components/views/dialogs/__snapshots__/LogoutDialog-test.tsx.snap diff --git a/src/components/views/dialogs/LogoutDialog.tsx b/src/components/views/dialogs/LogoutDialog.tsx index 2086a33b8a..b96cc3fd06 100644 --- a/src/components/views/dialogs/LogoutDialog.tsx +++ b/src/components/views/dialogs/LogoutDialog.tsx @@ -16,7 +16,6 @@ limitations under the License. */ import React from "react"; -import { IKeyBackupInfo } from "matrix-js-sdk/src/crypto/keybackup"; import { logger } from "matrix-js-sdk/src/logger"; import type CreateKeyBackupDialog from "../../../async-components/views/dialogs/security/CreateKeyBackupDialog"; @@ -35,10 +34,28 @@ interface IProps { onFinished: (success: boolean) => void; } +enum BackupStatus { + /** we're trying to figure out if there is an active backup */ + LOADING, + + /** crypto is disabled in this client (so no need to back up) */ + NO_CRYPTO, + + /** Key backup is active and working */ + BACKUP_ACTIVE, + + /** there is a backup on the server but we are not backing up to it */ + SERVER_BACKUP_BUT_DISABLED, + + /** backup is not set up locally and there is no backup on the server */ + NO_BACKUP, + + /** there was an error fetching the state */ + ERROR, +} + interface IState { - shouldLoadBackupStatus: boolean; - loading: boolean; - backupInfo: IKeyBackupInfo | null; + backupStatus: BackupStatus; } export default class LogoutDialog extends React.Component { @@ -49,33 +66,40 @@ export default class LogoutDialog extends React.Component { public constructor(props: IProps) { super(props); - const cli = MatrixClientPeg.safeGet(); - const shouldLoadBackupStatus = cli.isCryptoEnabled() && !cli.getKeyBackupEnabled(); - this.state = { - shouldLoadBackupStatus: shouldLoadBackupStatus, - loading: shouldLoadBackupStatus, - backupInfo: null, + backupStatus: BackupStatus.LOADING, }; - if (shouldLoadBackupStatus) { - this.loadBackupStatus(); - } + // we can't call setState() immediately, so wait a beat + window.setTimeout(() => this.startLoadBackupStatus(), 0); + } + + /** kick off the asynchronous calls to populate `state.backupStatus` in the background */ + private startLoadBackupStatus(): void { + this.loadBackupStatus().catch((e) => { + logger.log("Unable to fetch key backup status", e); + this.setState({ + backupStatus: BackupStatus.ERROR, + }); + }); } private async loadBackupStatus(): Promise { - try { - const backupInfo = await MatrixClientPeg.safeGet().getKeyBackupVersion(); - this.setState({ - loading: false, - backupInfo, - }); - } catch (e) { - logger.log("Unable to fetch key backup status", e); - this.setState({ - loading: false, - }); + const client = MatrixClientPeg.safeGet(); + const crypto = client.getCrypto(); + if (!crypto) { + this.setState({ backupStatus: BackupStatus.NO_CRYPTO }); + return; } + + if ((await crypto.getActiveSessionBackupVersion()) !== null) { + this.setState({ backupStatus: BackupStatus.BACKUP_ACTIVE }); + return; + } + + // backup is not active. see if there is a backup version on the server we ought to back up to. + const backupInfo = await client.getKeyBackupVersion(); + this.setState({ backupStatus: backupInfo ? BackupStatus.SERVER_BACKUP_BUT_DISABLED : BackupStatus.NO_BACKUP }); } private onExportE2eKeysClicked = (): void => { @@ -98,7 +122,7 @@ export default class LogoutDialog extends React.Component { }; private onSetRecoveryMethodClick = (): void => { - if (this.state.backupInfo) { + if (this.state.backupStatus === BackupStatus.SERVER_BACKUP_BUT_DISABLED) { // A key backup exists for this account, but the creating device is not // verified, so restore the backup which will give us the keys from it and // allow us to trust it (ie. upload keys to it) @@ -132,82 +156,106 @@ export default class LogoutDialog extends React.Component { this.props.onFinished(true); }; - public render(): React.ReactNode { - if (this.state.shouldLoadBackupStatus) { - const description = ( -
-

- {_t( - "Encrypted messages are secured with end-to-end encryption. Only you and the recipient(s) have the keys to read these messages.", - )} -

-

- {_t( - "When you sign out, these keys will be deleted from this device, which means you won't be able to read encrypted messages unless you have the keys for them on your other devices, or backed them up to the server.", - )} -

-

{_t("Back up your keys before signing out to avoid losing them.")}

-
- ); + /** + * Show a dialog prompting the user to set up key backup. + * + * Either there is no backup at all ({@link BackupStatus.NO_BACKUP}), there is a backup on the server but + * we are not connected to it ({@link BackupStatus.SERVER_BACKUP_BUT_DISABLED}), or we were unable to pull the + * backup data ({@link BackupStatus.ERROR}). In all three cases, we should prompt the user to set up key backup. + */ + private renderSetupBackupDialog(): React.ReactNode { + const description = ( +
+

+ {_t( + "Encrypted messages are secured with end-to-end encryption. Only you and the recipient(s) have the keys to read these messages.", + )} +

+

+ {_t( + "When you sign out, these keys will be deleted from this device, which means you won't be able to read encrypted messages unless you have the keys for them on your other devices, or backed them up to the server.", + )} +

+

{_t("Back up your keys before signing out to avoid losing them.")}

+
+ ); - let dialogContent; - if (this.state.loading) { - dialogContent = ; - } else { - let setupButtonCaption; - if (this.state.backupInfo) { - setupButtonCaption = _t("Connect this session to Key Backup"); - } else { - // if there's an error fetching the backup info, we'll just assume there's - // no backup for the purpose of the button caption - setupButtonCaption = _t("Start using Key Backup"); - } - - dialogContent = ( -
-
- {description} -
- - - -
- {_t("Advanced")} -

- -

-
-
- ); - } - // Not quite a standard question dialog as the primary button cancels - // the action and does something else instead, whilst non-default button - // confirms the action. - return ( - - {dialogContent} - - ); + let setupButtonCaption; + if (this.state.backupStatus === BackupStatus.SERVER_BACKUP_BUT_DISABLED) { + setupButtonCaption = _t("Connect this session to Key Backup"); } else { - return ( - - ); + // if there's an error fetching the backup info, we'll just assume there's + // no backup for the purpose of the button caption + setupButtonCaption = _t("Start using Key Backup"); + } + + const dialogContent = ( +
+
+ {description} +
+ + + +
+ {_t("Advanced")} +

+ +

+
+
+ ); + // Not quite a standard question dialog as the primary button cancels + // the action and does something else instead, whilst non-default button + // confirms the action. + return ( + + {dialogContent} + + ); + } + + public render(): React.ReactNode { + switch (this.state.backupStatus) { + case BackupStatus.LOADING: + // while we're deciding if we have backups, show a spinner + return ( + + ; + + ); + + case BackupStatus.NO_CRYPTO: + case BackupStatus.BACKUP_ACTIVE: + return ( + + ); + + case BackupStatus.NO_BACKUP: + case BackupStatus.SERVER_BACKUP_BUT_DISABLED: + case BackupStatus.ERROR: + return this.renderSetupBackupDialog(); } } } diff --git a/test/components/views/dialogs/LogoutDialog-test.tsx b/test/components/views/dialogs/LogoutDialog-test.tsx new file mode 100644 index 0000000000..c40c9ad894 --- /dev/null +++ b/test/components/views/dialogs/LogoutDialog-test.tsx @@ -0,0 +1,84 @@ +/* +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 React from "react"; +import { mocked, MockedObject } from "jest-mock"; +import { MatrixClient } from "matrix-js-sdk/src/matrix"; +import { CryptoApi, KeyBackupInfo } from "matrix-js-sdk/src/crypto-api"; +import { render, RenderResult } from "@testing-library/react"; + +import { filterConsole, getMockClientWithEventEmitter, mockClientMethodsCrypto } from "../../../test-utils"; +import LogoutDialog from "../../../../src/components/views/dialogs/LogoutDialog"; + +describe("LogoutDialog", () => { + let mockClient: MockedObject; + let mockCrypto: MockedObject; + + beforeEach(() => { + mockClient = getMockClientWithEventEmitter({ + ...mockClientMethodsCrypto(), + getKeyBackupVersion: jest.fn(), + }); + + mockCrypto = mocked(mockClient.getCrypto()!); + Object.assign(mockCrypto, { + getActiveSessionBackupVersion: jest.fn().mockResolvedValue(null), + }); + }); + + function renderComponent(props: Partial> = {}): RenderResult { + const onFinished = jest.fn(); + return render(); + } + + it("shows a regular dialog when crypto is disabled", async () => { + mocked(mockClient.getCrypto).mockReturnValue(undefined); + const rendered = renderComponent(); + await rendered.findByText("Are you sure you want to sign out?"); + expect(rendered.container).toMatchSnapshot(); + }); + + it("shows a regular dialog if backups are working", async () => { + mockCrypto.getActiveSessionBackupVersion.mockResolvedValue("1"); + const rendered = renderComponent(); + await rendered.findByText("Are you sure you want to sign out?"); + }); + + it("Prompts user to connect backup if there is a backup on the server", async () => { + mockClient.getKeyBackupVersion.mockResolvedValue({} as KeyBackupInfo); + const rendered = renderComponent(); + await rendered.findByText("Connect this session to Key Backup"); + expect(rendered.container).toMatchSnapshot(); + }); + + it("Prompts user to set up backup if there is no backup on the server", async () => { + mockClient.getKeyBackupVersion.mockResolvedValue(null); + const rendered = renderComponent(); + await rendered.findByText("Start using Key Backup"); + expect(rendered.container).toMatchSnapshot(); + }); + + describe("when there is an error fetching backups", () => { + filterConsole("Unable to fetch key backup status"); + it("prompts user to set up backup", async () => { + mockClient.getKeyBackupVersion.mockImplementation(async () => { + throw new Error("beep"); + }); + const rendered = renderComponent(); + await rendered.findByText("Start using Key Backup"); + }); + }); +}); diff --git a/test/components/views/dialogs/__snapshots__/LogoutDialog-test.tsx.snap b/test/components/views/dialogs/__snapshots__/LogoutDialog-test.tsx.snap new file mode 100644 index 0000000000..0e4a2763a3 --- /dev/null +++ b/test/components/views/dialogs/__snapshots__/LogoutDialog-test.tsx.snap @@ -0,0 +1,237 @@ +// Jest Snapshot v1, https://goo.gl/fbAQLP + +exports[`LogoutDialog Prompts user to connect backup if there is a backup on the server 1`] = ` +
+
+