Refactor and Move RedactedBodyView To Shared Components (#32772)

* refactoring and creation of shared-components for reductedBodyView

* move redacted message rendering to shared MVVM view

* Update snapshots + fix lint errors

* Remove MatrixClientPeg and use reguler react matrix client context

* Stop resyncing redacted body view models with mxEvent

* Fix redacted_because test fixtures for stricter event typing

* Simplify redacted body client access

* Watch timestamp setting in redacted body view model

* Refactor redacted and decryption failure body factories into MBodyFactory

* Prettier Fix

* Refactor FileBody into same pattern for consitancy
This commit is contained in:
Zack
2026-03-24 10:02:07 +00:00
committed by GitHub
parent d7843bb9b8
commit 4f3a1a2cc6
30 changed files with 688 additions and 159 deletions
@@ -19,7 +19,7 @@ import {
} from "../../../../test-utils";
import { MediaEventHelper } from "../../../../../src/utils/MediaEventHelper";
import SettingsStore from "../../../../../src/settings/SettingsStore";
import { FileBodyViewFactory, renderMBody } from "../../../../../src/components/views/messages/MBodyFactory";
import { FileBodyFactory, renderMBody } from "../../../../../src/components/views/messages/MBodyFactory";
import { TimelineRenderingType } from "../../../../../src/contexts/RoomContext.ts";
import { ScopedRoomContextProvider } from "../../../../../src/contexts/ScopedRoomContext.tsx";
@@ -108,7 +108,7 @@ describe("MBodyFactory", () => {
mxEvent: mediaEvent,
mediaEventHelper: new MediaEventHelper(mediaEvent),
},
FileBodyViewFactory,
FileBodyFactory,
)}
</ScopedRoomContextProvider>,
);
@@ -139,7 +139,7 @@ describe("MBodyFactory", () => {
mediaEventHelper: new MediaEventHelper(mediaEvent),
showFileInfo: true,
},
FileBodyViewFactory,
FileBodyFactory,
)}
</ScopedRoomContextProvider>,
);
@@ -17,6 +17,7 @@ import SettingsStore from "../../../../../src/settings/SettingsStore";
import { mkEvent, mkRoom, stubClient } from "../../../../test-utils";
import MessageEvent from "../../../../../src/components/views/messages/MessageEvent";
import { RoomPermalinkCreator } from "../../../../../src/utils/permalinks/Permalinks";
import MatrixClientContext from "../../../../../src/contexts/MatrixClientContext";
jest.mock("../../../../../src/components/views/messages/UnknownBody", () => ({
__esModule: true,
@@ -35,7 +36,9 @@ jest.mock("../../../../../src/components/views/messages/MVideoBody", () => ({
jest.mock("../../../../../src/components/views/messages/MBodyFactory", () => ({
__esModule: true,
FileBodyViewFactory: () => <div data-testid="file-body" />,
DecryptionFailureBodyFactory: () => <div data-testid="decryption-failure-body" />,
FileBodyFactory: () => <div data-testid="file-body" />,
RedactedBodyFactory: () => <div className="mx_RedactedBody">Message deleted by Moderator</div>,
renderMBody: () => <div data-testid="file-body" />,
}));
@@ -59,18 +62,61 @@ describe("MessageEvent", () => {
let client: MatrixClient;
let event: MatrixEvent;
const makeRedactedBecauseEvent = ({ sender, originServerTs }: { sender: string; originServerTs: number }) => ({
content: {},
event_id: "$redaction:example.com",
origin_server_ts: originServerTs,
redacts: "$message:example.com",
room_id: room.roomId,
sender,
type: EventType.RoomRedaction,
unsigned: {},
});
const renderMessageEvent = (): RenderResult => {
return render(<MessageEvent mxEvent={event} permalinkCreator={new RoomPermalinkCreator(room)} />);
return render(
<MatrixClientContext.Provider value={client}>
<MessageEvent mxEvent={event} permalinkCreator={new RoomPermalinkCreator(room)} />
</MatrixClientContext.Provider>,
);
};
beforeEach(() => {
client = stubClient();
room = mkRoom(client, "!room:example.com");
jest.spyOn(client, "getRoom").mockReturnValue(room);
jest.spyOn(SettingsStore, "getValue");
jest.spyOn(SettingsStore, "watchSetting");
jest.spyOn(SettingsStore, "unwatchSetting").mockImplementation(jest.fn());
});
it("renders the shared redacted body for redacted events", () => {
jest.spyOn(room, "getMember").mockReturnValue({ name: "Moderator" } as any);
event = mkEvent({
event: true,
type: EventType.RoomMessage,
user: "@alice:example.com",
room: room.roomId,
content: {
msgtype: MsgType.Text,
body: "Secret",
},
unsigned: {
redacted_because: makeRedactedBecauseEvent({
sender: "@moderator:example.com",
originServerTs: Date.UTC(2022, 10, 17, 15, 58, 32),
}),
},
});
jest.spyOn(event, "isRedacted").mockReturnValue(true);
const result = renderMessageEvent();
expect(result.getByText("Message deleted by Moderator")).toBeInTheDocument();
expect(result.container.querySelector(".mx_RedactedBody")).not.toBeNull();
expect(result.queryByTestId("textual-body")).toBeNull();
});
describe("when an image with a caption is sent", () => {
let result: RenderResult;
@@ -42,6 +42,7 @@ import { Action } from "../../../../../src/dispatcher/actions";
import PinningUtils from "../../../../../src/utils/PinningUtils";
import { Layout } from "../../../../../src/settings/enums/Layout";
import { ScopedRoomContextProvider } from "../../../../../src/contexts/ScopedRoomContext.tsx";
import SettingsStore from "../../../../../src/settings/SettingsStore";
describe("EventTile", () => {
const ROOM_ID = "!roomId:example.org";
@@ -94,6 +95,7 @@ describe("EventTile", () => {
jest.spyOn(client, "getRoom").mockReturnValue(room);
jest.spyOn(client, "decryptEventIfNeeded").mockResolvedValue();
jest.spyOn(SettingsStore, "getValue").mockReturnValue(false);
mxEvent = mkMessage({
room: room.roomId,
@@ -220,6 +222,22 @@ describe("EventTile", () => {
expect(container.getElementsByClassName("mx_EventTile_details")[0]).toHaveTextContent("@alice:example.org");
});
it("renders the shared redacted body for thread previews", () => {
jest.spyOn(mxEvent, "isRedacted").mockReturnValue(true);
jest.spyOn(mxEvent, "getUnsigned").mockReturnValue({
redacted_because: {
sender: "@moderator:example.org",
origin_server_ts: Date.UTC(2022, 10, 17, 15, 58, 32),
},
} as any);
const { container } = getComponent({}, TimelineRenderingType.ThreadsList);
const redactedBody = container.querySelector(".mx_RedactedBody");
expect(redactedBody).not.toBeNull();
expect(redactedBody).toHaveTextContent("Message deleted by @moderator:example.org");
});
it.each([
[TimelineRenderingType.Notification, Action.ViewRoom],
[TimelineRenderingType.ThreadsList, Action.ShowThread],