Live location share - disallow message pinning (PSF-1084)

src/components/views/context_menus/MessageContextMenu.tsx

@@ -1,6 +1,6 @@
 /*
 Copyright 2019 Michael Telatynski <7t3chguy@gmail.com>
-Copyright 2015 - 2021 The Matrix.org Foundation C.I.C.
+Copyright 2015 - 2022 The Matrix.org Foundation C.I.C.
 Copyright 2021 - 2022 Šimon Brandner <simon.bra.ag@gmail.com>
 
 Licensed under the Apache License, Version 2.0 (the "License");
@@ -30,7 +30,13 @@ import Modal from '../../../Modal';
 import Resend from '../../../Resend';
 import SettingsStore from '../../../settings/SettingsStore';
 import { isUrlPermitted } from '../../../HtmlUtils';
-import { canEditContent, editEvent, isContentActionable, isLocationEvent } from '../../../utils/EventUtils';
+import {
+    canEditContent,
+    canPinEvent,
+    editEvent,
+    isContentActionable,
+    isLocationEvent,
+} from '../../../utils/EventUtils';
 import IconizedContextMenu, { IconizedContextMenuOption, IconizedContextMenuOptionList } from './IconizedContextMenu';
 import { ReadPinsEventId } from "../right_panel/types";
 import { Action } from "../../../dispatcher/actions";
@@ -121,7 +127,9 @@ export default class MessageContextMenu extends React.Component<IProps, IState>
         const canRedact = room.currentState.maySendRedactionForEvent(this.props.mxEvent, cli.credentials.userId)
             && this.props.mxEvent.getType() !== EventType.RoomServerAcl
             && this.props.mxEvent.getType() !== EventType.RoomEncryption;
-        let canPin = room.currentState.mayClientSendStateEvent(EventType.RoomPinnedEvents, cli);
+
+        let canPin = room.currentState.mayClientSendStateEvent(EventType.RoomPinnedEvents, cli) &&
+            canPinEvent(this.props.mxEvent);
 
         // HACK: Intentionally say we can't pin if the user doesn't want to use the functionality
         if (!SettingsStore.getValue("feature_pinning")) canPin = false;
@@ -204,6 +212,7 @@ export default class MessageContextMenu extends React.Component<IProps, IState>
         const eventId = this.props.mxEvent.getId();
 
         const pinnedIds = room?.currentState?.getStateEvents(EventType.RoomPinnedEvents, "")?.getContent().pinned || [];
+
         if (pinnedIds.includes(eventId)) {
             pinnedIds.splice(pinnedIds.indexOf(eventId), 1);
         } else {

src/events/forward/getForwardableBeacon.ts

@@ -25,9 +25,9 @@ import { ForwardableEventTransformFunction } from "./types";
 export const getForwardableBeaconEvent: ForwardableEventTransformFunction = (event, cli) => {
     const room = cli.getRoom(event.getRoomId());
     const beacon = room.currentState.beacons?.get(getBeaconInfoIdentifier(event));
-    const latestLocationEvent = beacon.latestLocationEvent;
+    const latestLocationEvent = beacon?.latestLocationEvent;
 
-    if (beacon.isLive && latestLocationEvent) {
+    if (beacon?.isLive && latestLocationEvent) {
         return latestLocationEvent;
     }
     return null;

src/utils/EventUtils.ts

@@ -284,3 +284,7 @@ export const isLocationEvent = (event: MatrixEvent): boolean => {
 export function hasThreadSummary(event: MatrixEvent): boolean {
     return event.isThreadRoot && event.getThread()?.length && !!event.getThread().replyToEvent;
 }
+
+export function canPinEvent(event: MatrixEvent): boolean {
+    return !M_BEACON_INFO.matches(event.getType());
+}

test/components/views/context_menus/MessageContextMenu-test.tsx

@@ -23,37 +23,40 @@ import {
     BeaconIdentifier,
     Beacon,
     getBeaconInfoIdentifier,
+    EventType,
 } from 'matrix-js-sdk/src/matrix';
 import { ExtensibleEvent, MessageEvent, M_POLL_KIND_DISCLOSED, PollStartEvent } from 'matrix-events-sdk';
 import { Thread } from "matrix-js-sdk/src/models/thread";
 import { mocked } from "jest-mock";
 import { act } from '@testing-library/react';
 
-import * as TestUtils from '../../../test-utils';
 import { MatrixClientPeg } from '../../../../src/MatrixClientPeg';
 import RoomContext, { TimelineRenderingType } from "../../../../src/contexts/RoomContext";
 import { IRoomState } from "../../../../src/components/structures/RoomView";
-import { canEditContent, isContentActionable } from "../../../../src/utils/EventUtils";
+import { canEditContent } from "../../../../src/utils/EventUtils";
 import { copyPlaintext, getSelectedText } from "../../../../src/utils/strings";
 import MessageContextMenu from "../../../../src/components/views/context_menus/MessageContextMenu";
-import { makeBeaconEvent, makeBeaconInfoEvent } from '../../../test-utils';
+import { makeBeaconEvent, makeBeaconInfoEvent, stubClient } from '../../../test-utils';
 import dispatcher from '../../../../src/dispatcher/dispatcher';
+import SettingsStore from '../../../../src/settings/SettingsStore';
+import { ReadPinsEventId } from '../../../../src/components/views/right_panel/types';
 
 jest.mock("../../../../src/utils/strings", () => ({
     copyPlaintext: jest.fn(),
     getSelectedText: jest.fn(),
 }));
 jest.mock("../../../../src/utils/EventUtils", () => ({
+    // @ts-ignore don't mock everything
+    ...jest.requireActual("../../../../src/utils/EventUtils"),
     canEditContent: jest.fn(),
-    isContentActionable: jest.fn(),
-    isLocationEvent: jest.fn(),
 }));
 
 const roomId = 'roomid';
 
 describe('MessageContextMenu', () => {
     beforeEach(() => {
         jest.resetAllMocks();
+        stubClient();
     });
 
     it('does show copy link button when supplied a link', () => {
@@ -74,10 +77,151 @@ describe('MessageContextMenu', () => {
         expect(copyLinkButton).toHaveLength(0);
     });
 
+    describe('message pinning', () => {
+        beforeEach(() => {
+            jest.spyOn(SettingsStore, 'getValue').mockReturnValue(true);
+        });
+
+        afterAll(() => {
+            jest.spyOn(SettingsStore, 'getValue').mockRestore();
+        });
+
+        it('does not show pin option when user does not have rights to pin', () => {
+            const eventContent = MessageEvent.from("hello");
+            const event = new MatrixEvent(eventContent.serialize());
+
+            const room = makeDefaultRoom();
+            // mock permission to disallow adding pinned messages to room
+            jest.spyOn(room.currentState, 'mayClientSendStateEvent').mockReturnValue(false);
+
+            const menu = createMenu(event, {}, {}, undefined, room);
+
+            expect(menu.find('div[aria-label="Pin"]')).toHaveLength(0);
+        });
+
+        it('does not show pin option for beacon_info event', () => {
+            const deadBeaconEvent = makeBeaconInfoEvent('@alice:server.org', roomId, { isLive: false });
+
+            const room = makeDefaultRoom();
+            // mock permission to allow adding pinned messages to room
+            jest.spyOn(room.currentState, 'mayClientSendStateEvent').mockReturnValue(true);
+
+            const menu = createMenu(deadBeaconEvent, {}, {}, undefined, room);
+
+            expect(menu.find('div[aria-label="Pin"]')).toHaveLength(0);
+        });
+
+        it('does not show pin option when pinning feature is disabled', () => {
+            const eventContent = MessageEvent.from("hello");
+            const pinnableEvent = new MatrixEvent({ ...eventContent.serialize(), room_id: roomId });
+
+            const room = makeDefaultRoom();
+            // mock permission to allow adding pinned messages to room
+            jest.spyOn(room.currentState, 'mayClientSendStateEvent').mockReturnValue(true);
+            // disable pinning feature
+            jest.spyOn(SettingsStore, 'getValue').mockReturnValue(false);
+
+            const menu = createMenu(pinnableEvent, {}, {}, undefined, room);
+
+            expect(menu.find('div[aria-label="Pin"]')).toHaveLength(0);
+        });
+
+        it('shows pin option when pinning feature is enabled', () => {
+            const eventContent = MessageEvent.from("hello");
+            const pinnableEvent = new MatrixEvent({ ...eventContent.serialize(), room_id: roomId });
+
+            const room = makeDefaultRoom();
+            // mock permission to allow adding pinned messages to room
+            jest.spyOn(room.currentState, 'mayClientSendStateEvent').mockReturnValue(true);
+
+            const menu = createMenu(pinnableEvent, {}, {}, undefined, room);
+
+            expect(menu.find('div[aria-label="Pin"]')).toHaveLength(1);
+        });
+
+        it('pins event on pin option click', () => {
+            const onFinished = jest.fn();
+            const eventContent = MessageEvent.from("hello");
+            const pinnableEvent = new MatrixEvent({ ...eventContent.serialize(), room_id: roomId });
+            pinnableEvent.event.event_id = '!3';
+            const client = MatrixClientPeg.get();
+            const room = makeDefaultRoom();
+
+            // mock permission to allow adding pinned messages to room
+            jest.spyOn(room.currentState, 'mayClientSendStateEvent').mockReturnValue(true);
+
+            // mock read pins account data
+            const pinsAccountData = new MatrixEvent({ content: { event_ids: ['!1', '!2'] } });
+            jest.spyOn(room, 'getAccountData').mockReturnValue(pinsAccountData);
+
+            const menu = createMenu(pinnableEvent, { onFinished }, {}, undefined, room);
+
+            act(() => {
+                menu.find('div[aria-label="Pin"]').simulate('click');
+            });
+
+            // added to account data
+            expect(client.setRoomAccountData).toHaveBeenCalledWith(
+                roomId,
+                ReadPinsEventId,
+                { event_ids: [
+                    // from account data
+                    '!1', '!2',
+                    pinnableEvent.getId(),
+                ],
+                },
+            );
+
+            // add to room's pins
+            expect(client.sendStateEvent).toHaveBeenCalledWith(roomId, EventType.RoomPinnedEvents, {
+                pinned: [pinnableEvent.getId()] }, "");
+
+            expect(onFinished).toHaveBeenCalled();
+        });
+
+        it('unpins event on pin option click when event is pinned', () => {
+            const eventContent = MessageEvent.from("hello");
+            const pinnableEvent = new MatrixEvent({ ...eventContent.serialize(), room_id: roomId });
+            pinnableEvent.event.event_id = '!3';
+            const client = MatrixClientPeg.get();
+            const room = makeDefaultRoom();
+
+            // make the event already pinned in the room
+            const pinEvent = new MatrixEvent({
+                type: EventType.RoomPinnedEvents,
+                room_id: roomId,
+                state_key: "",
+                content: { pinned: [pinnableEvent.getId(), '!another-event'] },
+            });
+            room.currentState.setStateEvents([pinEvent]);
+
+            // mock permission to allow adding pinned messages to room
+            jest.spyOn(room.currentState, 'mayClientSendStateEvent').mockReturnValue(true);
+
+            // mock read pins account data
+            const pinsAccountData = new MatrixEvent({ content: { event_ids: ['!1', '!2'] } });
+            jest.spyOn(room, 'getAccountData').mockReturnValue(pinsAccountData);
+
+            const menu = createMenu(pinnableEvent, {}, {}, undefined, room);
+
+            act(() => {
+                menu.find('div[aria-label="Unpin"]').simulate('click');
+            });
+
+            expect(client.setRoomAccountData).not.toHaveBeenCalled();
+
+            // add to room's pins
+            expect(client.sendStateEvent).toHaveBeenCalledWith(
+                roomId, EventType.RoomPinnedEvents,
+                // pinnableEvent's id removed, other pins intact
+                { pinned: ['!another-event'] },
+                "",
+            );
+        });
+    });
+
     describe('message forwarding', () => {
         it('allows forwarding a room message', () => {
-            mocked(isContentActionable).mockReturnValue(true);
-
             const eventContent = MessageEvent.from("hello");
             const menu = createMenuWithContent(eventContent);
             expect(menu.find('div[aria-label="Forward"]')).toHaveLength(1);
@@ -91,9 +235,6 @@ describe('MessageContextMenu', () => {
 
         describe('forwarding beacons', () => {
             const aliceId = "@alice:server.org";
-            beforeEach(() => {
-                mocked(isContentActionable).mockReturnValue(true);
-            });
 
             it('does not allow forwarding a beacon that is not live', () => {
                 const deadBeaconEvent = makeBeaconInfoEvent(aliceId, roomId, { isLive: false });
@@ -212,7 +353,6 @@ describe('MessageContextMenu', () => {
             const context = {
                 canSendMessages: true,
             };
-            mocked(isContentActionable).mockReturnValue(true);
 
             const menu = createRightClickMenuWithContent(eventContent, context);
             const replyButton = menu.find('div[aria-label="Reply"]');
@@ -224,9 +364,11 @@ describe('MessageContextMenu', () => {
             const context = {
                 canSendMessages: true,
             };
-            mocked(isContentActionable).mockReturnValue(false);
+            const unsentMessage = new MatrixEvent(eventContent.serialize());
+            // queued messages are not actionable
+            unsentMessage.setStatus(EventStatus.QUEUED);
 
-            const menu = createRightClickMenuWithContent(eventContent, context);
+            const menu = createMenu(unsentMessage, {}, context);
             const replyButton = menu.find('div[aria-label="Reply"]');
             expect(replyButton).toHaveLength(0);
         });
@@ -236,7 +378,6 @@ describe('MessageContextMenu', () => {
             const context = {
                 canReact: true,
             };
-            mocked(isContentActionable).mockReturnValue(true);
 
             const menu = createRightClickMenuWithContent(eventContent, context);
             const reactButton = menu.find('div[aria-label="React"]');
@@ -296,24 +437,26 @@ function createMenuWithContent(
     return createMenu(mxEvent, props, context);
 }
 
+function makeDefaultRoom(): Room {
+    return new Room(
+        roomId,
+        MatrixClientPeg.get(),
+        "@user:example.com",
+        {
+            pendingEventOrdering: PendingEventOrdering.Detached,
+        },
+    );
+}
+
 function createMenu(
     mxEvent: MatrixEvent,
     props?: Partial<React.ComponentProps<typeof MessageContextMenu>>,
     context: Partial<IRoomState> = {},
     beacons: Map<BeaconIdentifier, Beacon> = new Map(),
+    room: Room = makeDefaultRoom(),
 ): ReactWrapper {
-    TestUtils.stubClient();
     const client = MatrixClientPeg.get();
 
-    const room = new Room(
-        roomId,
-        client,
-        "@user:example.com",
-        {
-            pendingEventOrdering: PendingEventOrdering.Detached,
-        },
-    );
-
     // @ts-ignore illegally set private prop
     room.currentState.beacons = beacons;