75d9898dff
* Modify useMediaVisible to take a room. * Add initial support for a account data level key. * Update controls. * Update settings * Lint and fixes * make some tests go happy * lint * i18n * update preferences * prettier * Update settings tab. * update screenshot * Update docs * Rewrite controller * Rewrite tons of tests * Rewrite RoomAvatar to be a functional component This is so we can use hooks to determine the setting state. * lint * lint * Tidy up comments * Apply media visible hook to inline images. * Move conditionals. * copyright all the things * Review changes * Update html utils to properly discard media. * Types fix * Fixing tests that break settings getValue expectations * Fix logic around media preview calculation * Fix room header tests * Fixup tests for timelinePanel * Clear settings in matrixchat * Update tests to use SettingsStore where possible. * fix bug * revert changes to client.ts * copyright years * Add header * Add a test for MediaPreviewAccountSettingsTab * Mark initMatrixClient as optional * Improve on types * Ensure we do not set the account data twice. * lint * Review changes * Ensure we include the client on rendered messages. * Fix test * update labels * clean designs * update settings tab * update snapshot * copyright * prevent mutation
100 lines
4.1 KiB
TypeScript
100 lines
4.1 KiB
TypeScript
/*
|
|
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 { render } from "jest-matrix-react";
|
|
import React from "react";
|
|
import userEvent from "@testing-library/user-event";
|
|
import { type MatrixClient, MatrixEvent } from "matrix-js-sdk/src/matrix";
|
|
|
|
import { MediaPreviewAccountSettings } from "../../../../../../../src/components/views/settings/tabs/user/MediaPreviewAccountSettings";
|
|
import {
|
|
getMockClientWithEventEmitter,
|
|
mockClientMethodsServer,
|
|
mockClientMethodsUser,
|
|
} from "../../../../../../test-utils";
|
|
import MatrixClientBackedController from "../../../../../../../src/settings/controllers/MatrixClientBackedController";
|
|
import MatrixClientBackedSettingsHandler from "../../../../../../../src/settings/handlers/MatrixClientBackedSettingsHandler";
|
|
import type { MockedObject } from "jest-mock";
|
|
import {
|
|
MEDIA_PREVIEW_ACCOUNT_DATA_TYPE,
|
|
type MediaPreviewConfig,
|
|
MediaPreviewValue,
|
|
} from "../../../../../../../src/@types/media_preview";
|
|
import MediaPreviewConfigController from "../../../../../../../src/settings/controllers/MediaPreviewConfigController";
|
|
|
|
describe("MediaPreviewAccountSettings", () => {
|
|
let client: MockedObject<MatrixClient>;
|
|
beforeEach(() => {
|
|
client = getMockClientWithEventEmitter({
|
|
...mockClientMethodsServer(),
|
|
...mockClientMethodsUser(),
|
|
getRoom: jest.fn(),
|
|
setAccountData: jest.fn(),
|
|
isVersionSupported: jest.fn().mockResolvedValue(true),
|
|
});
|
|
MatrixClientBackedController.matrixClient = client;
|
|
MatrixClientBackedSettingsHandler.matrixClient = client;
|
|
});
|
|
|
|
afterEach(() => {
|
|
jest.restoreAllMocks();
|
|
});
|
|
|
|
it("should render", () => {
|
|
const { getByLabelText } = render(<MediaPreviewAccountSettings />);
|
|
// Defaults
|
|
expect(getByLabelText("Hide avatars of room and inviter")).not.toBeChecked();
|
|
expect(getByLabelText("Always hide")).not.toBeChecked();
|
|
expect(getByLabelText("In private rooms")).not.toBeChecked();
|
|
expect(getByLabelText("Always show")).toBeChecked();
|
|
});
|
|
|
|
it("should be able to toggle hide avatar", async () => {
|
|
const { getByLabelText } = render(<MediaPreviewAccountSettings />);
|
|
// Defaults
|
|
const element = getByLabelText("Hide avatars of room and inviter");
|
|
await userEvent.click(element);
|
|
expect(client.setAccountData).toHaveBeenCalledWith(MEDIA_PREVIEW_ACCOUNT_DATA_TYPE, {
|
|
invite_avatars: MediaPreviewValue.Off,
|
|
media_previews: MediaPreviewValue.On,
|
|
});
|
|
// Ensure we don't double set the account data.
|
|
expect(client.setAccountData).toHaveBeenCalledTimes(1);
|
|
});
|
|
|
|
// Skip the default.
|
|
it.each([
|
|
["Always hide", MediaPreviewValue.Off],
|
|
["In private rooms", MediaPreviewValue.Private],
|
|
["Always show", MediaPreviewValue.On],
|
|
])("should be able to toggle media preview option %s", async (key, value) => {
|
|
if (value === MediaPreviewConfigController.default.media_previews) {
|
|
// This is the default, so switch away first.
|
|
client.getAccountData.mockImplementation((type) => {
|
|
if (type === MEDIA_PREVIEW_ACCOUNT_DATA_TYPE) {
|
|
return new MatrixEvent({
|
|
content: {
|
|
media_previews: MediaPreviewValue.Off,
|
|
} satisfies Partial<MediaPreviewConfig>,
|
|
});
|
|
}
|
|
return undefined;
|
|
});
|
|
}
|
|
const { getByLabelText } = render(<MediaPreviewAccountSettings />);
|
|
|
|
const element = getByLabelText(key);
|
|
await userEvent.click(element);
|
|
expect(client.setAccountData).toHaveBeenCalledWith(MEDIA_PREVIEW_ACCOUNT_DATA_TYPE, {
|
|
invite_avatars: MediaPreviewValue.On,
|
|
media_previews: value,
|
|
});
|
|
// Ensure we don't double set the account data.
|
|
expect(client.setAccountData).toHaveBeenCalledTimes(1);
|
|
});
|
|
});
|