riot-web/test/MatrixClientPeg-test.ts

/*
Copyright 2022 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 { logger } from "matrix-js-sdk/src/logger";
import fetchMockJest from "fetch-mock-jest";
import EventEmitter from "events";
import {
    ProvideCryptoSetupExtensions,
    SecretStorageKeyDescription,
} from "@matrix-org/react-sdk-module-api/lib/lifecycles/CryptoSetupExtensions";

import { advanceDateAndTime, stubClient } from "./test-utils";
import { IMatrixClientPeg, MatrixClientPeg as peg } from "../src/MatrixClientPeg";
import SettingsStore from "../src/settings/SettingsStore";
import Modal from "../src/Modal";
import PlatformPeg from "../src/PlatformPeg";
import { SettingLevel } from "../src/settings/SettingLevel";
import { Features } from "../src/settings/Settings";
import { ModuleRunner } from "../src/modules/ModuleRunner";

jest.useFakeTimers();

const PegClass = Object.getPrototypeOf(peg).constructor;

describe("MatrixClientPeg", () => {
    beforeEach(() => {
        // stub out Logger.log which gets called a lot and clutters up the test output
        jest.spyOn(logger, "log").mockImplementation(() => {});
    });

    afterEach(() => {
        localStorage.clear();
        jest.restoreAllMocks();

        // some of the tests assign `MatrixClientPeg.matrixClient`: clear it, to prevent leakage between tests
        peg.unset();
    });

    it("setJustRegisteredUserId", () => {
        stubClient();
        (peg as any).matrixClient = peg.get();
        peg.setJustRegisteredUserId("@userId:matrix.org");
        expect(peg.safeGet().credentials.userId).toBe("@userId:matrix.org");
        expect(peg.currentUserIsJustRegistered()).toBe(true);
        expect(peg.userRegisteredWithinLastHours(0)).toBe(false);
        expect(peg.userRegisteredWithinLastHours(1)).toBe(true);
        expect(peg.userRegisteredWithinLastHours(24)).toBe(true);
        advanceDateAndTime(1 * 60 * 60 * 1000 + 1);
        expect(peg.userRegisteredWithinLastHours(0)).toBe(false);
        expect(peg.userRegisteredWithinLastHours(1)).toBe(false);
        expect(peg.userRegisteredWithinLastHours(24)).toBe(true);
        advanceDateAndTime(24 * 60 * 60 * 1000);
        expect(peg.userRegisteredWithinLastHours(0)).toBe(false);
        expect(peg.userRegisteredWithinLastHours(1)).toBe(false);
        expect(peg.userRegisteredWithinLastHours(24)).toBe(false);
    });

    it("setJustRegisteredUserId(null)", () => {
        stubClient();
        (peg as any).matrixClient = peg.get();
        peg.setJustRegisteredUserId(null);
        expect(peg.currentUserIsJustRegistered()).toBe(false);
        expect(peg.userRegisteredWithinLastHours(0)).toBe(false);
        expect(peg.userRegisteredWithinLastHours(1)).toBe(false);
        expect(peg.userRegisteredWithinLastHours(24)).toBe(false);
        advanceDateAndTime(1 * 60 * 60 * 1000 + 1);
        expect(peg.userRegisteredWithinLastHours(0)).toBe(false);
        expect(peg.userRegisteredWithinLastHours(1)).toBe(false);
        expect(peg.userRegisteredWithinLastHours(24)).toBe(false);
    });

    describe(".start extensions", () => {
        let testPeg: IMatrixClientPeg;

        beforeEach(() => {
            // instantiate a MatrixClientPegClass instance, with a new MatrixClient
            testPeg = new PegClass();
            fetchMockJest.get("http://example.com/_matrix/client/versions", {});
        });

        describe("cryptoSetup extension", () => {
            it("should call default cryptoSetup.getDehydrationKeyCallback", async () => {
                const mockCryptoSetup = {
                    SHOW_ENCRYPTION_SETUP_UI: true,
                    examineLoginResponse: jest.fn(),
                    persistCredentials: jest.fn(),
                    getSecretStorageKey: jest.fn(),
                    createSecretStorageKey: jest.fn(),
                    catchAccessSecretStorageError: jest.fn(),
                    setupEncryptionNeeded: jest.fn(),
                    getDehydrationKeyCallback: jest.fn().mockReturnValue(null),
                } as ProvideCryptoSetupExtensions;

                // Ensure we have an instance before we set up spies
                const instance = ModuleRunner.instance;
                jest.spyOn(instance.extensions, "cryptoSetup", "get").mockReturnValue(mockCryptoSetup);

                testPeg.replaceUsingCreds({
                    accessToken: "SEKRET",
                    homeserverUrl: "http://example.com",
                    userId: "@user:example.com",
                    deviceId: "TEST_DEVICE_ID",
                });

                expect(mockCryptoSetup.getDehydrationKeyCallback).toHaveBeenCalledTimes(1);
            });

            it("should call overridden cryptoSetup.getDehydrationKeyCallback", async () => {
                const mockDehydrationKeyCallback = () => Uint8Array.from([0x11, 0x22, 0x33]);

                const mockCryptoSetup = {
                    SHOW_ENCRYPTION_SETUP_UI: true,
                    examineLoginResponse: jest.fn(),
                    persistCredentials: jest.fn(),
                    getSecretStorageKey: jest.fn(),
                    createSecretStorageKey: jest.fn(),
                    catchAccessSecretStorageError: jest.fn(),
                    setupEncryptionNeeded: jest.fn(),
                    getDehydrationKeyCallback: jest.fn().mockReturnValue(mockDehydrationKeyCallback),
                } as ProvideCryptoSetupExtensions;

                // Ensure we have an instance before we set up spies
                const instance = ModuleRunner.instance;
                jest.spyOn(instance.extensions, "cryptoSetup", "get").mockReturnValue(mockCryptoSetup);

                testPeg.replaceUsingCreds({
                    accessToken: "SEKRET",
                    homeserverUrl: "http://example.com",
                    userId: "@user:example.com",
                    deviceId: "TEST_DEVICE_ID",
                });
                expect(mockCryptoSetup.getDehydrationKeyCallback).toHaveBeenCalledTimes(1);

                const client = testPeg.get();
                const dehydrationKey = await client?.cryptoCallbacks.getDehydrationKey!(
                    {} as SecretStorageKeyDescription,
                    (key: Uint8Array) => true,
                );
                expect(dehydrationKey).toEqual(Uint8Array.from([0x11, 0x22, 0x33]));
            });
        });
    });

    describe(".start", () => {
        let testPeg: IMatrixClientPeg;

        beforeEach(() => {
            // instantiate a MatrixClientPegClass instance, with a new MatrixClient
            testPeg = new PegClass();
            fetchMockJest.get("http://example.com/_matrix/client/versions", {});
            testPeg.replaceUsingCreds({
                accessToken: "SEKRET",
                homeserverUrl: "http://example.com",
                userId: "@user:example.com",
                deviceId: "TEST_DEVICE_ID",
            });
        });

        describe("legacy crypto", () => {
            beforeEach(() => {
                const originalGetValue = SettingsStore.getValue;
                jest.spyOn(SettingsStore, "getValue").mockImplementation(
                    (settingName: string, roomId: string | null = null, excludeDefault = false) => {
                        if (settingName === "feature_rust_crypto") {
                            return false;
                        }
                        return originalGetValue(settingName, roomId, excludeDefault);
                    },
                );
            });

            it("should initialise client crypto", async () => {
                const mockInitCrypto = jest.spyOn(testPeg.safeGet(), "initCrypto").mockResolvedValue(undefined);
                const mockSetTrustCrossSignedDevices = jest
                    .spyOn(testPeg.safeGet(), "setCryptoTrustCrossSignedDevices")
                    .mockImplementation(() => {});
                const mockStartClient = jest.spyOn(testPeg.safeGet(), "startClient").mockResolvedValue(undefined);

                await testPeg.start();
                expect(mockInitCrypto).toHaveBeenCalledTimes(1);
                expect(mockSetTrustCrossSignedDevices).toHaveBeenCalledTimes(1);
                expect(mockStartClient).toHaveBeenCalledTimes(1);
            });

            it("should carry on regardless if there is an error initialising crypto", async () => {
                const e2eError = new Error("nope nope nope");
                const mockInitCrypto = jest.spyOn(testPeg.safeGet(), "initCrypto").mockRejectedValue(e2eError);
                const mockSetTrustCrossSignedDevices = jest
                    .spyOn(testPeg.safeGet(), "setCryptoTrustCrossSignedDevices")
                    .mockImplementation(() => {});
                const mockStartClient = jest.spyOn(testPeg.safeGet(), "startClient").mockResolvedValue(undefined);
                const mockWarning = jest.spyOn(logger, "warn").mockReturnValue(undefined);

                await testPeg.start();
                expect(mockInitCrypto).toHaveBeenCalledTimes(1);
                expect(mockSetTrustCrossSignedDevices).not.toHaveBeenCalled();
                expect(mockStartClient).toHaveBeenCalledTimes(1);
                expect(mockWarning).toHaveBeenCalledWith(expect.stringMatching("Unable to initialise e2e"), e2eError);
            });

            it("should reload when store database closes for a guest user", async () => {
                testPeg.safeGet().isGuest = () => true;
                const emitter = new EventEmitter();
                testPeg.safeGet().store.on = emitter.on.bind(emitter);
                const platform: any = { reload: jest.fn() };
                PlatformPeg.set(platform);
                await testPeg.assign({});
                emitter.emit("closed" as any);
                expect(platform.reload).toHaveBeenCalled();
            });

            it("should show error modal when store database closes", async () => {
                testPeg.safeGet().isGuest = () => false;
                const emitter = new EventEmitter();
                const platform: any = { getHumanReadableName: jest.fn() };
                PlatformPeg.set(platform);
                testPeg.safeGet().store.on = emitter.on.bind(emitter);
                const spy = jest.spyOn(Modal, "createDialog");
                await testPeg.assign({});
                emitter.emit("closed" as any);
                expect(spy).toHaveBeenCalled();
            });
        });

        it("should initialise the rust crypto library by default", async () => {
            await SettingsStore.setValue(Features.RustCrypto, null, SettingLevel.DEVICE, null);

            const mockSetValue = jest.spyOn(SettingsStore, "setValue").mockResolvedValue(undefined);

            const mockInitCrypto = jest.spyOn(testPeg.safeGet(), "initCrypto").mockResolvedValue(undefined);
            const mockInitRustCrypto = jest.spyOn(testPeg.safeGet(), "initRustCrypto").mockResolvedValue(undefined);

            const cryptoStoreKey = new Uint8Array([1, 2, 3, 4]);
            await testPeg.start({ rustCryptoStoreKey: cryptoStoreKey });
            expect(mockInitCrypto).not.toHaveBeenCalled();
            expect(mockInitRustCrypto).toHaveBeenCalledWith({ storageKey: cryptoStoreKey });

            // we should have stashed the setting in the settings store
            expect(mockSetValue).toHaveBeenCalledWith("feature_rust_crypto", null, SettingLevel.DEVICE, true);
        });

        it("should initialise the legacy crypto library if set", async () => {
            await SettingsStore.setValue(Features.RustCrypto, null, SettingLevel.DEVICE, null);

            const originalGetValue = SettingsStore.getValue;
            jest.spyOn(SettingsStore, "getValue").mockImplementation(
                (settingName: string, roomId: string | null = null, excludeDefault = false) => {
                    if (settingName === "feature_rust_crypto") {
                        return false;
                    }
                    return originalGetValue(settingName, roomId, excludeDefault);
                },
            );

            const mockSetValue = jest.spyOn(SettingsStore, "setValue").mockResolvedValue(undefined);

            const mockInitCrypto = jest.spyOn(testPeg.safeGet(), "initCrypto").mockResolvedValue(undefined);
            const mockInitRustCrypto = jest.spyOn(testPeg.safeGet(), "initRustCrypto").mockResolvedValue(undefined);

            await testPeg.start();
            expect(mockInitCrypto).toHaveBeenCalled();
            expect(mockInitRustCrypto).not.toHaveBeenCalled();

            // we should have stashed the setting in the settings store
            expect(mockSetValue).toHaveBeenCalledWith("feature_rust_crypto", null, SettingLevel.DEVICE, false);
        });

        describe("Rust staged rollout", () => {
            function mockSettingStore(
                userIsUsingRust: boolean,
                newLoginShouldUseRust: boolean,
                rolloutPercent: number | null,
            ) {
                const originalGetValue = SettingsStore.getValue;
                jest.spyOn(SettingsStore, "getValue").mockImplementation(
                    (settingName: string, roomId: string | null = null, excludeDefault = false) => {
                        if (settingName === "feature_rust_crypto") {
                            return userIsUsingRust;
                        }
                        return originalGetValue(settingName, roomId, excludeDefault);
                    },
                );
                const originalGetValueAt = SettingsStore.getValueAt;
                jest.spyOn(SettingsStore, "getValueAt").mockImplementation(
                    (level: SettingLevel, settingName: string) => {
                        if (settingName === "feature_rust_crypto") {
                            return newLoginShouldUseRust;
                        }
                        // if null we let the original implementation handle it to get the default
                        if (settingName === "RustCrypto.staged_rollout_percent" && rolloutPercent !== null) {
                            return rolloutPercent;
                        }
                        return originalGetValueAt(level, settingName);
                    },
                );
            }

            let mockSetValue: jest.SpyInstance;
            let mockInitCrypto: jest.SpyInstance;
            let mockInitRustCrypto: jest.SpyInstance;

            beforeEach(async () => {
                mockSetValue = jest.spyOn(SettingsStore, "setValue").mockResolvedValue(undefined);
                mockInitCrypto = jest.spyOn(testPeg.safeGet(), "initCrypto").mockResolvedValue(undefined);
                mockInitRustCrypto = jest.spyOn(testPeg.safeGet(), "initRustCrypto").mockResolvedValue(undefined);

                await SettingsStore.setValue(Features.RustCrypto, null, SettingLevel.DEVICE, null);
            });

            it("Should not migrate existing login if rollout is 0", async () => {
                mockSettingStore(false, true, 0);

                await testPeg.start();
                expect(mockInitCrypto).toHaveBeenCalled();
                expect(mockInitRustCrypto).not.toHaveBeenCalledTimes(1);

                // we should have stashed the setting in the settings store
                expect(mockSetValue).toHaveBeenCalledWith("feature_rust_crypto", null, SettingLevel.DEVICE, false);
            });

            it("Should migrate existing login if rollout is 100", async () => {
                mockSettingStore(false, true, 100);
                await testPeg.start();
                expect(mockInitCrypto).not.toHaveBeenCalled();
                expect(mockInitRustCrypto).toHaveBeenCalledTimes(1);

                // we should have stashed the setting in the settings store
                expect(mockSetValue).toHaveBeenCalledWith("feature_rust_crypto", null, SettingLevel.DEVICE, true);
            });

            it("Should migrate existing login if user is in rollout bucket", async () => {
                mockSettingStore(false, true, 30);

                // Use a device id that is known to be in the 30% bucket (hash modulo 100 < 30)
                const spy = jest.spyOn(testPeg.get()!, "getDeviceId").mockReturnValue("AAA");

                await testPeg.start();
                expect(mockInitCrypto).not.toHaveBeenCalled();
                expect(mockInitRustCrypto).toHaveBeenCalledTimes(1);

                // we should have stashed the setting in the settings store
                expect(mockSetValue).toHaveBeenCalledWith("feature_rust_crypto", null, SettingLevel.DEVICE, true);

                spy.mockReset();
            });

            it("Should not migrate existing login if rollout is malformed", async () => {
                mockSettingStore(false, true, 100.1);

                await testPeg.start();
                expect(mockInitCrypto).toHaveBeenCalled();
                expect(mockInitRustCrypto).not.toHaveBeenCalledTimes(1);

                // we should have stashed the setting in the settings store
                expect(mockSetValue).toHaveBeenCalledWith("feature_rust_crypto", null, SettingLevel.DEVICE, false);
            });

            it("Default is to not migrate", async () => {
                mockSettingStore(false, true, null);

                await testPeg.start();
                expect(mockInitCrypto).toHaveBeenCalled();
                expect(mockInitRustCrypto).not.toHaveBeenCalledTimes(1);

                // we should have stashed the setting in the settings store
                expect(mockSetValue).toHaveBeenCalledWith("feature_rust_crypto", null, SettingLevel.DEVICE, false);
            });

            it("Should not migrate if feature_rust_crypto is false", async () => {
                mockSettingStore(false, false, 100);

                await testPeg.start();
                expect(mockInitCrypto).toHaveBeenCalled();
                expect(mockInitRustCrypto).not.toHaveBeenCalledTimes(1);

                // we should have stashed the setting in the settings store
                expect(mockSetValue).toHaveBeenCalledWith("feature_rust_crypto", null, SettingLevel.DEVICE, false);
            });
        });
    });
});