mirror of
https://github.com/vector-im/element-web.git
synced 2024-11-15 20:54:59 +08:00
More pinned messages tests (#7988)
* Test basic pinned message functionality Signed-off-by: Robin Townsend <robin@robin.town> * Test pinned polls Signed-off-by: Robin Townsend <robin@robin.town> * Fix test Signed-off-by: Robin Townsend <robin@robin.town>
This commit is contained in:
Robin
GitHub
parent
b981a96b29
commit
77ed1e3ef8
@ -19,6 +19,15 @@ import { mount } from "enzyme";
|
||||
import { act } from "react-dom/test-utils";
|
||||
import { MatrixEvent } from "matrix-js-sdk/src/models/event";
|
||||
import { EventType, RelationType, MsgType } from "matrix-js-sdk/src/@types/event";
|
||||
import { RoomStateEvent } from "matrix-js-sdk/src/models/room-state";
|
||||
import {
|
||||
M_POLL_RESPONSE,
|
||||
M_POLL_END,
|
||||
M_POLL_KIND_DISCLOSED,
|
||||
PollStartEvent,
|
||||
PollResponseEvent,
|
||||
PollEndEvent,
|
||||
} from "matrix-events-sdk";
|
||||
|
||||
import "../../../skinned-sdk";
|
||||
import {
|
||||
@ -31,27 +40,30 @@ import {
|
||||
import { MatrixClientPeg } from "../../../../src/MatrixClientPeg";
|
||||
import _PinnedMessagesCard from "../../../../src/components/views/right_panel/PinnedMessagesCard";
|
||||
import PinnedEventTile from "../../../../src/components/views/rooms/PinnedEventTile";
|
||||
import MPollBody from "../../../../src/components/views/messages/MPollBody.tsx";
|
||||
|
||||
const PinnedMessagesCard = wrapInMatrixClientContext(_PinnedMessagesCard);
|
||||
|
||||
describe("<PinnedMessagesCard />", () => {
|
||||
stubClient();
|
||||
const cli = MatrixClientPeg.get();
|
||||
cli.getUserId.mockReturnValue("@alice:example.org");
|
||||
cli.setRoomAccountData = () => {};
|
||||
cli.relations = jest.fn().mockResolvedValue({ events: [] });
|
||||
const PinnedMessagesCard = wrapInMatrixClientContext(_PinnedMessagesCard);
|
||||
|
||||
const mkRoom = (localPins: MatrixEvent[], nonLocalPins: MatrixEvent[]) => {
|
||||
const pins = [...localPins, ...nonLocalPins];
|
||||
const mkRoom = (localPins: MatrixEvent[], nonLocalPins: MatrixEvent[]): Room => {
|
||||
const room = mkStubRoom("!room:example.org");
|
||||
// Deferred since we may be adding or removing pins later
|
||||
const pins = () => [...localPins, ...nonLocalPins];
|
||||
|
||||
// Insert pin IDs into room state
|
||||
const pinState = mkEvent({
|
||||
room.currentState.getStateEvents.mockImplementation(() => mkEvent({
|
||||
event: true,
|
||||
type: EventType.RoomPinnedEvents,
|
||||
content: {
|
||||
pinned: pins.map(e => e.getId()),
|
||||
pinned: pins().map(e => e.getId()),
|
||||
},
|
||||
});
|
||||
room.currentState.getStateEvents.mockReturnValue(pinState);
|
||||
}));
|
||||
|
||||
// Insert local pins into local timeline set
|
||||
room.getUnfilteredTimelineSet = () => ({
|
||||
@ -61,11 +73,86 @@ describe("<PinnedMessagesCard />", () => {
|
||||
});
|
||||
|
||||
// Return all pins over fetchRoomEvent
|
||||
cli.fetchRoomEvent = (roomId, eventId) => pins.find(e => e.getId() === eventId)?.event;
|
||||
cli.fetchRoomEvent = (roomId, eventId) => pins().find(e => e.getId() === eventId)?.event;
|
||||
|
||||
return room;
|
||||
};
|
||||
|
||||
const mountPins = async (room: Room): ReactWrapper => {
|
||||
let pins;
|
||||
await act(async () => {
|
||||
pins = mount(<PinnedMessagesCard room={room} onClose={() => {}} />);
|
||||
// Wait a tick for state updates
|
||||
await new Promise(resolve => setImmediate(resolve));
|
||||
});
|
||||
pins.update();
|
||||
|
||||
return pins;
|
||||
};
|
||||
|
||||
const emitPinUpdates = async (pins: ReactWrapper) => {
|
||||
const room = pins.props().room;
|
||||
const pinListener = room.currentState.on.mock.calls
|
||||
.find(([eventName, listener]) => eventName === RoomStateEvent.Events)[1];
|
||||
|
||||
await act(async () => {
|
||||
// Emit the update
|
||||
pinListener(room.currentState.getStateEvents());
|
||||
// Wait a tick for state updates
|
||||
await new Promise(resolve => setImmediate(resolve));
|
||||
});
|
||||
pins.update();
|
||||
};
|
||||
|
||||
const pin1 = mkMessage({
|
||||
event: true,
|
||||
room: "!room:example.org",
|
||||
user: "@alice:example.org",
|
||||
msg: "First pinned message",
|
||||
});
|
||||
const pin2 = mkMessage({
|
||||
event: true,
|
||||
room: "!room:example.org",
|
||||
user: "@alice:example.org",
|
||||
msg: "The second one",
|
||||
});
|
||||
|
||||
it("updates when messages are pinned", async () => {
|
||||
// Start with nothing pinned
|
||||
const localPins = [];
|
||||
const nonLocalPins = [];
|
||||
const pins = await mountPins(mkRoom(localPins, nonLocalPins));
|
||||
expect(pins.find(PinnedEventTile).length).toBe(0);
|
||||
|
||||
// Pin the first message
|
||||
localPins.push(pin1);
|
||||
await emitPinUpdates(pins);
|
||||
expect(pins.find(PinnedEventTile).length).toBe(1);
|
||||
|
||||
// Pin the second message
|
||||
nonLocalPins.push(pin2);
|
||||
await emitPinUpdates(pins);
|
||||
expect(pins.find(PinnedEventTile).length).toBe(2);
|
||||
});
|
||||
|
||||
it("updates when messages are unpinned", async () => {
|
||||
// Start with two pins
|
||||
const localPins = [pin1];
|
||||
const nonLocalPins = [pin2];
|
||||
const pins = await mountPins(mkRoom(localPins, nonLocalPins));
|
||||
expect(pins.find(PinnedEventTile).length).toBe(2);
|
||||
|
||||
// Unpin the first message
|
||||
localPins.pop();
|
||||
await emitPinUpdates(pins);
|
||||
expect(pins.find(PinnedEventTile).length).toBe(1);
|
||||
|
||||
// Unpin the second message
|
||||
nonLocalPins.pop();
|
||||
await emitPinUpdates(pins);
|
||||
expect(pins.find(PinnedEventTile).length).toBe(0);
|
||||
});
|
||||
|
||||
it("hides unpinnable events found in local timeline", async () => {
|
||||
// Redacted messages are unpinnable
|
||||
const pin = mkEvent({
|
||||
@ -75,13 +162,7 @@ describe("<PinnedMessagesCard />", () => {
|
||||
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();
|
||||
const pins = await mountPins(mkRoom([pin], []));
|
||||
expect(pins.find(PinnedEventTile).length).toBe(0);
|
||||
});
|
||||
|
||||
@ -94,23 +175,11 @@ describe("<PinnedMessagesCard />", () => {
|
||||
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();
|
||||
const pins = await mountPins(mkRoom([], [pin]));
|
||||
expect(pins.find(PinnedEventTile).length).toBe(0);
|
||||
});
|
||||
|
||||
it("accounts for edits", async () => {
|
||||
const pin = mkMessage({
|
||||
event: true,
|
||||
room: "!room:example.org",
|
||||
user: "@alice:example.org",
|
||||
msg: "Hello!",
|
||||
});
|
||||
cli.relations.mockResolvedValue({
|
||||
events: [mkEvent({
|
||||
event: true,
|
||||
@ -119,29 +188,67 @@ describe("<PinnedMessagesCard />", () => {
|
||||
user: "@alice:example.org",
|
||||
content: {
|
||||
"msgtype": MsgType.Text,
|
||||
"body": " * Hello again!",
|
||||
"body": " * First pinned message, edited",
|
||||
"m.new_content": {
|
||||
msgtype: MsgType.Text,
|
||||
body: "Hello again!",
|
||||
body: "First pinned message, edited",
|
||||
},
|
||||
"m.relates_to": {
|
||||
rel_type: RelationType.Replace,
|
||||
event_id: pin.getId(),
|
||||
event_id: pin1.getId(),
|
||||
},
|
||||
},
|
||||
})],
|
||||
});
|
||||
|
||||
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();
|
||||
|
||||
const pins = await mountPins(mkRoom([], [pin1]));
|
||||
const pinTile = pins.find(PinnedEventTile);
|
||||
expect(pinTile.length).toBe(1);
|
||||
expect(pinTile.find(".mx_EventTile_body").text()).toEqual("Hello again!");
|
||||
expect(pinTile.find(".mx_EventTile_body").text()).toEqual("First pinned message, edited");
|
||||
});
|
||||
|
||||
it("displays votes on polls not found in local timeline", async () => {
|
||||
const poll = mkEvent({
|
||||
...PollStartEvent.from("A poll", ["Option 1", "Option 2"], M_POLL_KIND_DISCLOSED).serialize(),
|
||||
event: true,
|
||||
room: "!room:example.org",
|
||||
user: "@alice:example.org",
|
||||
});
|
||||
|
||||
const answers = (poll.unstableExtensibleEvent as PollStartEvent).answers;
|
||||
const responses = [
|
||||
["@alice:example.org", 0],
|
||||
["@bob:example.org", 0],
|
||||
["@eve:example.org", 1],
|
||||
].map(([user, option], i) => mkEvent({
|
||||
...PollResponseEvent.from([answers[option].id], poll.getId()).serialize(),
|
||||
event: true,
|
||||
room: "!room:example.org",
|
||||
user,
|
||||
}));
|
||||
const end = mkEvent({
|
||||
...PollEndEvent.from(poll.getId(), "Closing the poll").serialize(),
|
||||
event: true,
|
||||
room: "!room:example.org",
|
||||
user: "@alice:example.org",
|
||||
});
|
||||
|
||||
// Make the responses available
|
||||
cli.relations.mockImplementation((roomId, eventId, relationType, eventType) => {
|
||||
if (eventId === poll.getId() && relationType === RelationType.Reference) {
|
||||
switch (eventType) {
|
||||
case M_POLL_RESPONSE.name: return { events: responses };
|
||||
case M_POLL_END.name: return { events: [end] };
|
||||
}
|
||||
}
|
||||
return { events: [] };
|
||||
});
|
||||
|
||||
const pins = await mountPins(mkRoom([], [poll]));
|
||||
const pinTile = pins.find(MPollBody);
|
||||
expect(pinTile.length).toEqual(1);
|
||||
expect(pinTile.find(".mx_MPollBody_option_ended").length).toEqual(2);
|
||||
expect(pinTile.find(".mx_MPollBody_optionVoteCount").first().text()).toEqual("2 votes");
|
||||
expect(pinTile.find(".mx_MPollBody_optionVoteCount").last().text()).toEqual("1 vote");
|
||||
});
|
||||
});
|
||||
|
||||
@ -334,6 +334,7 @@ export function mkStubRoom(roomId = null, name: string, client: MatrixClient): R
|
||||
getMember: jest.fn(),
|
||||
mayClientSendStateEvent: jest.fn().mockReturnValue(true),
|
||||
maySendStateEvent: jest.fn().mockReturnValue(true),
|
||||
maySendRedactionForEvent: jest.fn().mockReturnValue(true),
|
||||
maySendEvent: jest.fn().mockReturnValue(true),
|
||||
members: {},
|
||||
getJoinRule: jest.fn().mockReturnValue(JoinRule.Invite),
|
||||
|
||||
Loading…
Reference in New Issue
Block a user