/* Copyright 2024 New Vector Ltd. Copyright 2022 The Matrix.org Foundation C.I.C. SPDX-License-Identifier: AGPL-3.0-only OR GPL-3.0-only Please see LICENSE files in the repository root for full details. */ import { ClientEvent, MatrixClient, Room, SyncState } from "matrix-js-sdk/src/matrix"; import BasePlatform from "../../src/BasePlatform"; import SdkConfig from "../../src/SdkConfig"; import { SettingLevel } from "../../src/settings/SettingLevel"; import SettingsStore from "../../src/settings/SettingsStore"; import { mkStubRoom, mockPlatformPeg, stubClient } from "../test-utils"; const TEST_DATA = [ { name: "Electron.showTrayIcon", level: SettingLevel.PLATFORM, value: true, }, ]; /** * An existing setting that has {@link IBaseSetting#supportedLevelsAreOrdered} set to true. */ const SETTING_NAME_WITH_CONFIG_OVERRIDE = "feature_msc3531_hide_messages_pending_moderation"; describe("SettingsStore", () => { let platformSettings: Record; beforeAll(() => { jest.clearAllMocks(); platformSettings = {}; mockPlatformPeg({ isLevelSupported: jest.fn().mockReturnValue(true), supportsSetting: jest.fn().mockReturnValue(true), setSettingValue: jest.fn().mockImplementation((settingName: string, value: any) => { platformSettings[settingName] = value; }), getSettingValue: jest.fn().mockImplementation((settingName: string) => { return platformSettings[settingName]; }), reload: jest.fn(), } as unknown as BasePlatform); TEST_DATA.forEach((d) => { SettingsStore.setValue(d.name, null, d.level, d.value); }); }); beforeEach(() => { SdkConfig.reset(); }); describe("getValueAt", () => { TEST_DATA.forEach((d) => { it(`should return the value "${d.level}"."${d.name}"`, () => { expect(SettingsStore.getValueAt(d.level, d.name)).toBe(d.value); // regression test #22545 expect(SettingsStore.getValueAt(d.level, d.name)).toBe(d.value); }); }); it(`supportedLevelsAreOrdered correctly overrides setting`, async () => { SdkConfig.put({ features: { [SETTING_NAME_WITH_CONFIG_OVERRIDE]: false, }, }); await SettingsStore.setValue(SETTING_NAME_WITH_CONFIG_OVERRIDE, null, SettingLevel.DEVICE, true); expect(SettingsStore.getValue(SETTING_NAME_WITH_CONFIG_OVERRIDE)).toBe(false); }); it(`supportedLevelsAreOrdered doesn't incorrectly override setting`, async () => { await SettingsStore.setValue(SETTING_NAME_WITH_CONFIG_OVERRIDE, null, SettingLevel.DEVICE, true); expect(SettingsStore.getValueAt(SettingLevel.DEVICE, SETTING_NAME_WITH_CONFIG_OVERRIDE)).toBe(true); }); }); describe("runMigrations", () => { let client: MatrixClient; let room: Room; let localStorageSetItemSpy: jest.SpyInstance; let localStorageSetPromise: Promise; beforeEach(() => { client = stubClient(); room = mkStubRoom("!room:example.org", "Room", client); room.getAccountData = jest.fn().mockReturnValue({ getContent: jest.fn().mockReturnValue({ urlPreviewsEnabled_e2ee: true, }), }); client.getRooms = jest.fn().mockReturnValue([room]); client.getRoom = jest.fn().mockReturnValue(room); localStorageSetPromise = new Promise((resolve) => { localStorageSetItemSpy = jest .spyOn(localStorage.__proto__, "setItem") .mockImplementation(() => resolve()); }); }); afterEach(() => { jest.restoreAllMocks(); }); it("migrates URL previews setting for e2ee rooms", async () => { SettingsStore.runMigrations(false); client.emit(ClientEvent.Sync, SyncState.Prepared, null); expect(room.getAccountData).toHaveBeenCalled(); await localStorageSetPromise; expect(localStorageSetItemSpy!).toHaveBeenCalledWith( `mx_setting_urlPreviewsEnabled_e2ee_${room.roomId}`, JSON.stringify({ value: true }), ); }); it("does not migrate e2ee URL previews on a fresh login", async () => { SettingsStore.runMigrations(true); client.emit(ClientEvent.Sync, SyncState.Prepared, null); expect(room.getAccountData).not.toHaveBeenCalled(); }); it("does not migrate if the device is flagged as migrated", async () => { jest.spyOn(localStorage.__proto__, "getItem").mockImplementation((key: unknown): string | undefined => { if (key === "url_previews_e2ee_migration_done") return JSON.stringify({ value: true }); return undefined; }); SettingsStore.runMigrations(false); client.emit(ClientEvent.Sync, SyncState.Prepared, null); expect(room.getAccountData).not.toHaveBeenCalled(); }); }); });