Set up key backup using non-deprecated APIs (#12005)

test/SecurityManager-test.ts

@@ -0,0 +1,62 @@
+/*
+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 { mocked } from "jest-mock";
+import { CryptoApi } from "matrix-js-sdk/src/crypto-api";
+
+import { accessSecretStorage } from "../src/SecurityManager";
+import { filterConsole, stubClient } from "./test-utils";
+
+describe("SecurityManager", () => {
+    describe("accessSecretStorage", () => {
+        filterConsole("Not setting dehydration key: no SSSS key found");
+
+        it("runs the function passed in", async () => {
+            // Given a client
+            const crypto = {
+                bootstrapCrossSigning: () => {},
+                bootstrapSecretStorage: () => {},
+            } as unknown as CryptoApi;
+            const client = stubClient();
+            mocked(client.hasSecretStorageKey).mockResolvedValue(true);
+            mocked(client.getCrypto).mockReturnValue(crypto);
+
+            // When I run accessSecretStorage
+            const func = jest.fn();
+            await accessSecretStorage(func);
+
+            // Then we call the passed-in function
+            expect(func).toHaveBeenCalledTimes(1);
+        });
+
+        describe("expecting errors", () => {
+            filterConsole("End-to-end encryption is disabled - unable to access secret storage");
+
+            it("throws if crypto is unavailable", async () => {
+                // Given a client with no crypto
+                const client = stubClient();
+                mocked(client.hasSecretStorageKey).mockResolvedValue(true);
+                mocked(client.getCrypto).mockReturnValue(undefined);
+
+                // When I run accessSecretStorage
+                // Then we throw an error
+                await expect(async () => {
+                    await accessSecretStorage(jest.fn());
+                }).rejects.toThrow("End-to-end encryption is disabled - unable to access secret storage");
+            });
+        });
+    });
+});

test/components/views/dialogs/security/CreateKeyBackupDialog-test.tsx

@@ -19,11 +19,13 @@ import React from "react";
 import { mocked } from "jest-mock";
 
 import CreateKeyBackupDialog from "../../../../../src/async-components/views/dialogs/security/CreateKeyBackupDialog";
-import { createTestClient } from "../../../../test-utils";
+import { createTestClient, filterConsole } from "../../../../test-utils";
 import { MatrixClientPeg } from "../../../../../src/MatrixClientPeg";
 
 jest.mock("../../../../../src/SecurityManager", () => ({
-    accessSecretStorage: jest.fn().mockResolvedValue(undefined),
+    accessSecretStorage: async (func = async () => Promise<void>) => {
+        await func();
+    },
 }));
 
 describe("CreateKeyBackupDialog", () => {
@@ -39,16 +41,33 @@ describe("CreateKeyBackupDialog", () => {
         expect(asFragment()).toMatchSnapshot();
     });
 
-    it("should display the error message when backup creation failed", async () => {
-        const matrixClient = createTestClient();
-        mocked(matrixClient.scheduleAllGroupSessionsForBackup).mockRejectedValue("my error");
-        MatrixClientPeg.safeGet = MatrixClientPeg.get = () => matrixClient;
+    describe("expecting failure", () => {
+        filterConsole("Error creating key backup");
 
-        const { asFragment } = render(<CreateKeyBackupDialog onFinished={jest.fn()} />);
+        it("should display an error message when backup creation failed", async () => {
+            const matrixClient = createTestClient();
+            mocked(matrixClient.getCrypto()!.resetKeyBackup).mockImplementation(() => {
+                throw new Error("failed");
+            });
+            MatrixClientPeg.safeGet = MatrixClientPeg.get = () => matrixClient;
 
-        // Check if the error message is displayed
-        await waitFor(() => expect(screen.getByText("Unable to create key backup")).toBeDefined());
-        expect(asFragment()).toMatchSnapshot();
+            const { asFragment } = render(<CreateKeyBackupDialog onFinished={jest.fn()} />);
+
+            // Check if the error message is displayed
+            await waitFor(() => expect(screen.getByText("Unable to create key backup")).toBeDefined());
+            expect(asFragment()).toMatchSnapshot();
+        });
+
+        it("should display an error message when there is no Crypto available", async () => {
+            const matrixClient = createTestClient();
+            mocked(matrixClient.getCrypto).mockReturnValue(undefined);
+            MatrixClientPeg.safeGet = MatrixClientPeg.get = () => matrixClient;
+
+            render(<CreateKeyBackupDialog onFinished={jest.fn()} />);
+
+            // Check if the error message is displayed
+            await waitFor(() => expect(screen.getByText("Unable to create key backup")).toBeDefined());
+        });
     });
 
     it("should display the success dialog when the key backup is finished", async () => {

test/components/views/dialogs/security/__snapshots__/CreateKeyBackupDialog-test.tsx.snap

@@ -1,6 +1,6 @@
 // Jest Snapshot v1, https://goo.gl/fbAQLP
 
-exports[`CreateKeyBackupDialog should display the error message when backup creation failed 1`] = `
+exports[`CreateKeyBackupDialog expecting failure should display an error message when backup creation failed 1`] = `
 <DocumentFragment>
   <div
     data-focus-guard="true"

test/test-utils/test-utils.ts

@@ -132,6 +132,7 @@ export function createTestClient(): MatrixClient {
             getUserDeviceInfo: jest.fn(),
             getUserVerificationStatus: jest.fn(),
             getDeviceVerificationStatus: jest.fn(),
+            resetKeyBackup: jest.fn(),
         }),
 
         getPushActionsForEvent: jest.fn(),