Skip to content
This repository was archived by the owner on Sep 11, 2024. It is now read-only.

Hide unpinnable pinned messages in more cases #7921

Merged
merged 11 commits into from
Mar 3, 2022
2 changes: 1 addition & 1 deletion src/components/views/right_panel/PinnedMessagesCard.tsx
Original file line number Diff line number Diff line change
Expand Up @@ -99,7 +99,7 @@ const PinnedMessagesCard = ({ room, onClose }: IProps) => {
const promises = pinnedEventIds.map(async eventId => {
const timelineSet = room.getUnfilteredTimelineSet();
const localEvent = timelineSet?.getTimelineForEvent(eventId)?.getEvents().find(e => e.getId() === eventId);
if (localEvent) return localEvent;
if (localEvent) return PinningUtils.isPinnable(localEvent) ? localEvent : null;

try {
// Fetch the event and latest edit in parallel
Expand Down
100 changes: 100 additions & 0 deletions test/components/views/right_panel/PinnedMessagesCard-test.tsx
Original file line number Diff line number Diff line change
@@ -0,0 +1,100 @@
/*
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 React from "react";
import { mount } from "enzyme";
import { act } from "react-dom/test-utils";
import { MatrixEvent } from "matrix-js-sdk/src/models/event";
import { EventType } from "matrix-js-sdk/src/@types/event";

import "../../../skinned-sdk";
import { stubClient, wrapInMatrixClientContext, mkStubRoom, mkEvent } from "../../../test-utils";
import { MatrixClientPeg } from "../../../../src/MatrixClientPeg";
import _PinnedMessagesCard from "../../../../src/components/views/right_panel/PinnedMessagesCard";
import PinnedEventTile from "../../../../src/components/views/rooms/PinnedEventTile";

describe("<PinnedMessagesCard />", () => {
stubClient();
const cli = MatrixClientPeg.get();
cli.setRoomAccountData = () => {};
cli.relations = jest.fn().mockResolvedValue({ events: [] });
const PinnedMessagesCard = wrapInMatrixClientContext(_PinnedMessagesCard);

const mkRoom = (localPins: MatrixEvent[], nonLocalPins: MatrixEvent[]) => {
const pins = [...localPins, ...nonLocalPins];
const room = mkStubRoom();

// Insert pin IDs into room state
const pinState = mkEvent({
event: true,
type: EventType.RoomPinnedEvents,
content: {
pinned: pins.map(e => e.getId()),
},
});
room.currentState.getStateEvents.mockReturnValue(pinState);

// Insert local pins into local timeline set
room.getUnfilteredTimelineSet = () => ({
getTimelineForEvent: () => ({
getEvents: () => localPins,
}),
});

// Return all pins over fetchRoomEvent
cli.fetchRoomEvent = (roomId, eventId) => pins.find(e => e.getId() === eventId)?.event;

return room;
};

it("hides unpinnable events found in local timeline", async () => {
// Redacted messages are unpinnable
const pin = mkEvent({
event: true,
type: EventType.RoomMessage,
content: {},
unsigned: { redacted_because: {} },
});

let pins;
await act(async () => {
pins = mount(<PinnedMessagesCard room={mkRoom([pin], [])} onClose={() => {}} />);
// Wait a tick for state updates
await new Promise(resolve => setImmediate(resolve));
});
pins.update();
expect(pins.find(PinnedEventTile).length).toBe(0);
});

it("hides unpinnable events not found in local timeline", async () => {
// Redacted messages are unpinnable
const pin = mkEvent({
event: true,
type: EventType.RoomMessage,
content: {},
unsigned: { redacted_because: {} },
});

let pins;
await act(async () => {
pins = mount(<PinnedMessagesCard room={mkRoom([], [pin])} onClose={() => {}} />);
// Wait a tick for state updates
await new Promise(resolve => setImmediate(resolve));
});
pins.update();
expect(pins.find(PinnedEventTile).length).toBe(0);
});
});
1 change: 1 addition & 0 deletions test/test-utils/test-utils.ts
Original file line number Diff line number Diff line change
Expand Up @@ -172,6 +172,7 @@ export function mkEvent(opts: MakeEventProps): MatrixEvent {
prev_content: opts.prev_content,
event_id: "$" + Math.random() + "-" + Math.random(),
origin_server_ts: opts.ts,
unsigned: opts.unsigned,
};
if (opts.skey) {
event.state_key = opts.skey;
Expand Down