element-web/test/unit-tests/settings/controllers/MediaPreviewConfigController-test.ts

/*
Copyright 2025 New Vector Ltd.

SPDX-License-Identifier: AGPL-3.0-only OR GPL-3.0-only OR LicenseRef-Element-Commercial
Please see LICENSE files in the repository root for full details.
*/

import { MatrixEvent } from "matrix-js-sdk/src/matrix";

import MatrixClientBackedController from "../../../../src/settings/controllers/MatrixClientBackedController";
import MediaPreviewConfigController from "../../../../src/settings/controllers/MediaPreviewConfigController";
import { SettingLevel } from "../../../../src/settings/SettingLevel";
import { getMockClientWithEventEmitter, mockClientMethodsServer } from "../../../test-utils";
import { MEDIA_PREVIEW_ACCOUNT_DATA_TYPE, MediaPreviewValue } from "../../../../src/@types/media_preview";

describe("MediaPreviewConfigController", () => {
    afterEach(() => {
        jest.restoreAllMocks();
    });

    const ROOM_ID = "!room:example.org";

    it("gets the default settings when none are specified.", () => {
        const controller = new MediaPreviewConfigController();

        MatrixClientBackedController.matrixClient = getMockClientWithEventEmitter({
            ...mockClientMethodsServer(),
            getAccountData: jest.fn().mockReturnValue(null),
        });

        const value = controller.getValueOverride(SettingLevel.ACCOUNT, null);
        expect(value).toEqual(MediaPreviewConfigController.default);
    });

    it("gets the default settings when the setting is empty.", () => {
        const controller = new MediaPreviewConfigController();

        MatrixClientBackedController.matrixClient = getMockClientWithEventEmitter({
            ...mockClientMethodsServer(),
            getAccountData: jest
                .fn()
                .mockReturnValue(new MatrixEvent({ type: MEDIA_PREVIEW_ACCOUNT_DATA_TYPE, content: {} })),
        });

        const value = controller.getValueOverride(SettingLevel.ACCOUNT, null);
        expect(value).toEqual(MediaPreviewConfigController.default);
    });

    it.each([["media_previews"], ["invite_avatars"]])("gets the correct value for %s at the global level", (key) => {
        const controller = new MediaPreviewConfigController();

        MatrixClientBackedController.matrixClient = getMockClientWithEventEmitter({
            ...mockClientMethodsServer(),
            getAccountData: jest.fn().mockReturnValue(
                new MatrixEvent({
                    type: MEDIA_PREVIEW_ACCOUNT_DATA_TYPE,
                    content: {
                        [key]: MediaPreviewValue.Off,
                    },
                }),
            ),
            getRoom: jest.fn().mockReturnValue({
                getAccountData: jest.fn().mockReturnValue(null),
            }),
        });

        const globalValue = controller.getValueOverride(SettingLevel.ACCOUNT, null);
        expect(globalValue[key]).toEqual(MediaPreviewValue.Off);

        // Should follow the global value.
        const roomValue = controller.getValueOverride(SettingLevel.ROOM_ACCOUNT, ROOM_ID);
        expect(roomValue[key]).toEqual(MediaPreviewValue.Off);
    });

    it.each([["media_previews"], ["invite_avatars"]])("gets the correct value for %s at the room level", (key) => {
        const controller = new MediaPreviewConfigController();

        MatrixClientBackedController.matrixClient = getMockClientWithEventEmitter({
            ...mockClientMethodsServer(),
            getAccountData: jest.fn().mockReturnValue(null),
            getRoom: jest.fn().mockReturnValue({
                getAccountData: jest.fn().mockReturnValue(
                    new MatrixEvent({
                        type: MEDIA_PREVIEW_ACCOUNT_DATA_TYPE,
                        content: {
                            [key]: MediaPreviewValue.Off,
                        },
                    }),
                ),
            }),
        });

        const globalValue = controller.getValueOverride(SettingLevel.ACCOUNT, null);
        expect(globalValue[key]).toEqual(MediaPreviewValue.On);

        // Should follow the global value.
        const roomValue = controller.getValueOverride(SettingLevel.ROOM_ACCOUNT, ROOM_ID);
        expect(roomValue[key]).toEqual(MediaPreviewValue.Off);
    });

    it.each([["media_previews"], ["invite_avatars"]])(
        "uses defaults when an invalid value is set on the global level",
        (key) => {
            const controller = new MediaPreviewConfigController();

            MatrixClientBackedController.matrixClient = getMockClientWithEventEmitter({
                ...mockClientMethodsServer(),
                getAccountData: jest.fn().mockReturnValue(
                    new MatrixEvent({
                        type: MEDIA_PREVIEW_ACCOUNT_DATA_TYPE,
                        content: {
                            [key]: "bibble",
                        },
                    }),
                ),
                getRoom: jest.fn().mockReturnValue({
                    getAccountData: jest.fn().mockReturnValue(null),
                }),
            });

            const globalValue = controller.getValueOverride(SettingLevel.ACCOUNT, null);
            expect(globalValue[key]).toEqual(MediaPreviewValue.On);

            // Should follow the global value.
            const roomValue = controller.getValueOverride(SettingLevel.ROOM_ACCOUNT, ROOM_ID);
            expect(roomValue[key]).toEqual(MediaPreviewValue.On);
        },
    );
    it.each([["media_previews"], ["invite_avatars"]])(
        "uses global value when an invalid value is set on the room level",
        (key) => {
            const controller = new MediaPreviewConfigController();

            MatrixClientBackedController.matrixClient = getMockClientWithEventEmitter({
                ...mockClientMethodsServer(),
                getAccountData: jest.fn().mockReturnValue(
                    new MatrixEvent({
                        type: MEDIA_PREVIEW_ACCOUNT_DATA_TYPE,
                        content: {
                            [key]: MediaPreviewValue.Off,
                        },
                    }),
                ),
                getRoom: jest.fn().mockReturnValue({
                    getAccountData: jest.fn().mockReturnValue(
                        new MatrixEvent({
                            type: MEDIA_PREVIEW_ACCOUNT_DATA_TYPE,
                            content: {
                                [key]: "bibble",
                            },
                        }),
                    ),
                }),
            });

            const globalValue = controller.getValueOverride(SettingLevel.ACCOUNT, null);
            expect(globalValue[key]).toEqual(MediaPreviewValue.Off);

            // Should follow the global value.
            const roomValue = controller.getValueOverride(SettingLevel.ROOM_ACCOUNT, ROOM_ID);
            expect(roomValue[key]).toEqual(MediaPreviewValue.Off);
        },
    );
});