LogoutDialog: Remove usage of deprecated keybackup API (#11645)

* tests for LogoutDialog

* LogoutDialog: Remove usage of deprecated keybackup API

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;
+    backupStatus: BackupStatus;
-    loading: boolean;
-    backupInfo: IKeyBackupInfo | null;
 }
 
 export default class LogoutDialog extends React.Component<IProps, IState> {
@@ -49,33 +66,40 @@ export default class LogoutDialog extends React.Component<IProps, IState> {
     public constructor(props: IProps) {
         super(props);
 
-        const cli = MatrixClientPeg.safeGet();
-        const shouldLoadBackupStatus = cli.isCryptoEnabled() && !cli.getKeyBackupEnabled();
-
         this.state = {
-            shouldLoadBackupStatus: shouldLoadBackupStatus,
+            backupStatus: BackupStatus.LOADING,
-            loading: shouldLoadBackupStatus,
-            backupInfo: null,
         };
 
-        if (shouldLoadBackupStatus) {
+        // we can't call setState() immediately, so wait a beat
-            this.loadBackupStatus();
+        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<void> {
-        try {
+        const client = MatrixClientPeg.safeGet();
-            const backupInfo = await MatrixClientPeg.safeGet().getKeyBackupVersion();
+        const crypto = client.getCrypto();
-            this.setState({
+        if (!crypto) {
-                loading: false,
+            this.setState({ backupStatus: BackupStatus.NO_CRYPTO });
-                backupInfo,
+            return;
-            });
-        } catch (e) {
-            logger.log("Unable to fetch key backup status", e);
-            this.setState({
-                loading: false,
-            });
         }
+
+        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<IProps, IState> {
     };
 
     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,8 +156,14 @@ export default class LogoutDialog extends React.Component<IProps, IState> {
         this.props.onFinished(true);
     };
 
-    public render(): React.ReactNode {
+    /**
-        if (this.state.shouldLoadBackupStatus) {
+     * 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 = (
             <div>
                 <p>
@@ -150,12 +180,8 @@ export default class LogoutDialog extends React.Component<IProps, IState> {
             </div>
         );
 
-            let dialogContent;
-            if (this.state.loading) {
-                dialogContent = <Spinner />;
-            } else {
         let setupButtonCaption;
-                if (this.state.backupInfo) {
+        if (this.state.backupStatus === BackupStatus.SERVER_BACKUP_BUT_DISABLED) {
             setupButtonCaption = _t("Connect this session to Key Backup");
         } else {
             // if there's an error fetching the backup info, we'll just assume there's
@@ -163,7 +189,7 @@ export default class LogoutDialog extends React.Component<IProps, IState> {
             setupButtonCaption = _t("Start using Key Backup");
         }
 
-                dialogContent = (
+        const dialogContent = (
             <div>
                 <div className="mx_Dialog_content" id="mx_Dialog_content">
                     {description}
@@ -184,7 +210,6 @@ export default class LogoutDialog extends React.Component<IProps, IState> {
                 </details>
             </div>
         );
-            }
         // 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.
@@ -198,7 +223,25 @@ export default class LogoutDialog extends React.Component<IProps, IState> {
                 {dialogContent}
             </BaseDialog>
         );
-        } else {
+    }
+
+    public render(): React.ReactNode {
+        switch (this.state.backupStatus) {
+            case BackupStatus.LOADING:
+                // while we're deciding if we have backups, show a spinner
+                return (
+                    <BaseDialog
+                        title={_t("action|sign_out")}
+                        contentId="mx_Dialog_content"
+                        hasCancel={true}
+                        onFinished={this.onFinished}
+                    >
+                        <Spinner />;
+                    </BaseDialog>
+                );
+
+            case BackupStatus.NO_CRYPTO:
+            case BackupStatus.BACKUP_ACTIVE:
                 return (
                     <QuestionDialog
                         hasCancelButton={true}
@@ -208,6 +251,11 @@ export default class LogoutDialog extends React.Component<IProps, IState> {
                         onFinished={this.onFinished}
                     />
                 );
+
+            case BackupStatus.NO_BACKUP:
+            case BackupStatus.SERVER_BACKUP_BUT_DISABLED:
+            case BackupStatus.ERROR:
+                return this.renderSetupBackupDialog();
         }
     }
 }

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<MatrixClient>;
+    let mockCrypto: MockedObject<CryptoApi>;
+
+    beforeEach(() => {
+        mockClient = getMockClientWithEventEmitter({
+            ...mockClientMethodsCrypto(),
+            getKeyBackupVersion: jest.fn(),
+        });
+
+        mockCrypto = mocked(mockClient.getCrypto()!);
+        Object.assign(mockCrypto, {
+            getActiveSessionBackupVersion: jest.fn().mockResolvedValue(null),
+        });
+    });
+
+    function renderComponent(props: Partial<React.ComponentProps<typeof LogoutDialog>> = {}): RenderResult {
+        const onFinished = jest.fn();
+        return render(<LogoutDialog onFinished={onFinished} {...props} />);
+    }
+
+    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");
+        });
+    });
+});

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`] = `
+<div>
+  <div
+    data-focus-guard="true"
+    style="width: 1px; height: 0px; padding: 0px; overflow: hidden; position: fixed; top: 1px; left: 1px;"
+    tabindex="0"
+  />
+  <div
+    aria-describedby="mx_Dialog_content"
+    aria-labelledby="mx_BaseDialog_title"
+    class="mx_Dialog_fixedWidth"
+    data-focus-lock-disabled="false"
+    role="dialog"
+  >
+    <div
+      class="mx_Dialog_header mx_Dialog_headerWithCancel"
+    >
+      <h2
+        class="mx_Heading_h3 mx_Dialog_title"
+        id="mx_BaseDialog_title"
+      >
+        You'll lose access to your encrypted messages
+      </h2>
+      <div
+        aria-label="Close dialog"
+        class="mx_AccessibleButton mx_Dialog_cancelButton"
+        role="button"
+        tabindex="0"
+      />
+    </div>
+    <div>
+      <div
+        class="mx_Dialog_content"
+        id="mx_Dialog_content"
+      >
+        <div>
+          <p>
+            Encrypted messages are secured with end-to-end encryption. Only you and the recipient(s) have the keys to read these messages.
+          </p>
+          <p>
+            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.
+          </p>
+          <p>
+            Back up your keys before signing out to avoid losing them.
+          </p>
+        </div>
+      </div>
+      <div
+        class="mx_Dialog_buttons"
+      >
+        <span
+          class="mx_Dialog_buttons_row"
+        >
+          <button>
+            I don't want my encrypted messages
+          </button>
+          <button
+            class="mx_Dialog_primary"
+            data-testid="dialog-primary-button"
+            type="button"
+          >
+            Connect this session to Key Backup
+          </button>
+        </span>
+      </div>
+      <details>
+        <summary>
+          Advanced
+        </summary>
+        <p>
+          <button>
+            Manually export keys
+          </button>
+        </p>
+      </details>
+    </div>
+  </div>
+  <div
+    data-focus-guard="true"
+    style="width: 1px; height: 0px; padding: 0px; overflow: hidden; position: fixed; top: 1px; left: 1px;"
+    tabindex="0"
+  />
+</div>
+`;
+
+exports[`LogoutDialog Prompts user to set up backup if there is no backup on the server 1`] = `
+<div>
+  <div
+    data-focus-guard="true"
+    style="width: 1px; height: 0px; padding: 0px; overflow: hidden; position: fixed; top: 1px; left: 1px;"
+    tabindex="0"
+  />
+  <div
+    aria-describedby="mx_Dialog_content"
+    aria-labelledby="mx_BaseDialog_title"
+    class="mx_Dialog_fixedWidth"
+    data-focus-lock-disabled="false"
+    role="dialog"
+  >
+    <div
+      class="mx_Dialog_header mx_Dialog_headerWithCancel"
+    >
+      <h2
+        class="mx_Heading_h3 mx_Dialog_title"
+        id="mx_BaseDialog_title"
+      >
+        You'll lose access to your encrypted messages
+      </h2>
+      <div
+        aria-label="Close dialog"
+        class="mx_AccessibleButton mx_Dialog_cancelButton"
+        role="button"
+        tabindex="0"
+      />
+    </div>
+    <div>
+      <div
+        class="mx_Dialog_content"
+        id="mx_Dialog_content"
+      >
+        <div>
+          <p>
+            Encrypted messages are secured with end-to-end encryption. Only you and the recipient(s) have the keys to read these messages.
+          </p>
+          <p>
+            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.
+          </p>
+          <p>
+            Back up your keys before signing out to avoid losing them.
+          </p>
+        </div>
+      </div>
+      <div
+        class="mx_Dialog_buttons"
+      >
+        <span
+          class="mx_Dialog_buttons_row"
+        >
+          <button>
+            I don't want my encrypted messages
+          </button>
+          <button
+            class="mx_Dialog_primary"
+            data-testid="dialog-primary-button"
+            type="button"
+          >
+            Start using Key Backup
+          </button>
+        </span>
+      </div>
+      <details>
+        <summary>
+          Advanced
+        </summary>
+        <p>
+          <button>
+            Manually export keys
+          </button>
+        </p>
+      </details>
+    </div>
+  </div>
+  <div
+    data-focus-guard="true"
+    style="width: 1px; height: 0px; padding: 0px; overflow: hidden; position: fixed; top: 1px; left: 1px;"
+    tabindex="0"
+  />
+</div>
+`;
+
+exports[`LogoutDialog shows a regular dialog when crypto is disabled 1`] = `
+<div>
+  <div
+    data-focus-guard="true"
+    style="width: 1px; height: 0px; padding: 0px; overflow: hidden; position: fixed; top: 1px; left: 1px;"
+    tabindex="0"
+  />
+  <div
+    aria-describedby="mx_Dialog_content"
+    aria-labelledby="mx_BaseDialog_title"
+    class="mx_QuestionDialog mx_Dialog_fixedWidth"
+    data-focus-lock-disabled="false"
+    role="dialog"
+  >
+    <div
+      class="mx_Dialog_header mx_Dialog_headerWithCancel"
+    >
+      <h2
+        class="mx_Heading_h3 mx_Dialog_title"
+        id="mx_BaseDialog_title"
+      >
+        Sign out
+      </h2>
+      <div
+        aria-label="Close dialog"
+        class="mx_AccessibleButton mx_Dialog_cancelButton"
+        role="button"
+        tabindex="0"
+      />
+    </div>
+    <div
+      class="mx_Dialog_content"
+      id="mx_Dialog_content"
+    >
+      Are you sure you want to sign out?
+    </div>
+    <div
+      class="mx_Dialog_buttons"
+    >
+      <span
+        class="mx_Dialog_buttons_row"
+      >
+        <button
+          data-testid="dialog-cancel-button"
+          type="button"
+        >
+          Cancel
+        </button>
+        <button
+          class="mx_Dialog_primary"
+          data-testid="dialog-primary-button"
+          type="button"
+        >
+          Sign out
+        </button>
+      </span>
+    </div>
+  </div>
+  <div
+    data-focus-guard="true"
+    style="width: 1px; height: 0px; padding: 0px; overflow: hidden; position: fixed; top: 1px; left: 1px;"
+    tabindex="0"
+  />
+</div>
+`;