Merge branch 'develop' into johannes/latest-room-in-space

src/components/views/messages/RoomCreate.tsx

@@ -27,11 +27,15 @@ import EventTileBubble from "./EventTileBubble";
 import { ViewRoomPayload } from "../../../dispatcher/payloads/ViewRoomPayload";
 
 interface IProps {
-    /* the MatrixEvent to show */
+    /** The m.room.create MatrixEvent that this tile represents */
     mxEvent: MatrixEvent;
     timestamp?: JSX.Element;
 }
 
+/**
+ * A message tile showing that this room was created as an upgrade of a previous
+ * room.
+ */
 export default class RoomCreate extends React.Component<IProps> {
     private onLinkClicked = (e: React.MouseEvent): void => {
         e.preventDefault();

src/components/views/settings/tabs/room/AdvancedRoomSettingsTab.tsx

@@ -19,13 +19,14 @@ import { EventType } from "matrix-js-sdk/src/@types/event";
 
 import { _t } from "../../../../../languageHandler";
 import { MatrixClientPeg } from "../../../../../MatrixClientPeg";
-import AccessibleButton from "../../../elements/AccessibleButton";
+import AccessibleButton, { ButtonEvent } from "../../../elements/AccessibleButton";
 import RoomUpgradeDialog from "../../../dialogs/RoomUpgradeDialog";
 import Modal from "../../../../../Modal";
 import dis from "../../../../../dispatcher/dispatcher";
 import { Action } from "../../../../../dispatcher/actions";
 import CopyableText from "../../../elements/CopyableText";
 import { ViewRoomPayload } from "../../../../../dispatcher/payloads/ViewRoomPayload";
+import SettingsStore from "../../../../../settings/SettingsStore";
 
 interface IProps {
     roomId: string;
@@ -46,9 +47,11 @@ interface IState {
 }
 
 export default class AdvancedRoomSettingsTab extends React.Component<IProps, IState> {
-    public constructor(props, context) {
+    public constructor(props: IProps, context: any) {
         super(props, context);
 
+        const msc3946ProcessDynamicPredecessor = SettingsStore.getValue("feature_dynamic_room_predecessors");
+
         this.state = {
             // This is eventually set to the value of room.getRecommendedVersion()
             upgradeRecommendation: null,
@@ -60,11 +63,10 @@ export default class AdvancedRoomSettingsTab extends React.Component<IProps, ISt
             const tombstone = room.currentState.getStateEvents(EventType.RoomTombstone, "");
 
             const additionalStateChanges: Partial<IState> = {};
-            const createEvent = room.currentState.getStateEvents(EventType.RoomCreate, "");
+            const predecessor = room.findPredecessor(msc3946ProcessDynamicPredecessor);
-            const predecessor = createEvent ? createEvent.getContent().predecessor : null;
+            if (predecessor) {
-            if (predecessor && predecessor.room_id) {
+                additionalStateChanges.oldRoomId = predecessor.roomId;
-                additionalStateChanges.oldRoomId = predecessor.room_id;
+                additionalStateChanges.oldEventId = predecessor.eventId;
-                additionalStateChanges.oldEventId = predecessor.event_id;
             }
 
             this.setState({
@@ -75,12 +77,12 @@ export default class AdvancedRoomSettingsTab extends React.Component<IProps, ISt
         });
     }
 
-    private upgradeRoom = (e): void => {
+    private upgradeRoom = (): void => {
         const room = MatrixClientPeg.get().getRoom(this.props.roomId);
         Modal.createDialog(RoomUpgradeDialog, { room });
     };
 
-    private onOldRoomClicked = (e): void => {
+    private onOldRoomClicked = (e: ButtonEvent): void => {
         e.preventDefault();
         e.stopPropagation();
 

src/i18n/strings/en_EN.json

@@ -955,6 +955,8 @@
     "New group call experience": "New group call experience",
     "Live Location Sharing": "Live Location Sharing",
     "Temporary implementation. Locations persist in room history.": "Temporary implementation. Locations persist in room history.",
+    "Dynamic room predecessors": "Dynamic room predecessors",
+    "Enable MSC3946 (to support late-arriving room archives)": "Enable MSC3946 (to support late-arriving room archives)",
     "Favourite Messages": "Favourite Messages",
     "Under active development.": "Under active development.",
     "Force 15s voice broadcast chunk length": "Force 15s voice broadcast chunk length",

src/settings/Settings.tsx

@@ -439,6 +439,15 @@ export const SETTINGS: { [setting: string]: ISetting } = {
         shouldWarn: true,
         default: false,
     },
+    "feature_dynamic_room_predecessors": {
+        isFeature: true,
+        labsGroup: LabGroup.Rooms,
+        supportedLevels: LEVELS_FEATURE,
+        displayName: _td("Dynamic room predecessors"),
+        description: _td("Enable MSC3946 (to support late-arriving room archives)"),
+        shouldWarn: true,
+        default: false,
+    },
     "feature_favourite_messages": {
         isFeature: true,
         labsGroup: LabGroup.Messaging,

test/components/views/messages/RoomCreate-test.tsx

@@ -0,0 +1,87 @@
+/*
+Copyright 2023 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 { act, render, screen, waitFor } from "@testing-library/react";
+import userEvent from "@testing-library/user-event";
+import { mocked } from "jest-mock";
+import { EventType, MatrixEvent } from "matrix-js-sdk/src/matrix";
+
+import dis from "../../../../src/dispatcher/dispatcher";
+import SettingsStore from "../../../../src/settings/SettingsStore";
+import RoomCreate from "../../../../src/components/views/messages/RoomCreate";
+import { stubClient } from "../../../test-utils/test-utils";
+import { Action } from "../../../../src/dispatcher/actions";
+
+jest.mock("../../../../src/dispatcher/dispatcher");
+
+describe("<RoomCreate />", () => {
+    const userId = "@alice:server.org";
+    const roomId = "!room:server.org";
+    const createEvent = new MatrixEvent({
+        type: EventType.RoomCreate,
+        sender: userId,
+        room_id: roomId,
+        content: {
+            predecessor: { room_id: "old_room_id", event_id: "tombstone_event_id" },
+        },
+        event_id: "$create",
+    });
+
+    beforeEach(() => {
+        jest.clearAllMocks();
+        mocked(dis.dispatch).mockReset();
+        jest.spyOn(SettingsStore, "getValue").mockReturnValue(false);
+        jest.spyOn(SettingsStore, "setValue").mockResolvedValue(undefined);
+        stubClient();
+    });
+
+    afterAll(() => {
+        jest.spyOn(SettingsStore, "getValue").mockRestore();
+        jest.spyOn(SettingsStore, "setValue").mockRestore();
+    });
+
+    it("Renders as expected", () => {
+        const roomCreate = render(<RoomCreate mxEvent={createEvent} />);
+        expect(roomCreate.asFragment()).toMatchSnapshot();
+    });
+
+    it("Links to the old version of the room", () => {
+        render(<RoomCreate mxEvent={createEvent} />);
+        expect(screen.getByText("Click here to see older messages.")).toHaveAttribute(
+            "href",
+            "https://matrix.to/#/old_room_id/tombstone_event_id",
+        );
+    });
+
+    it("Opens the old room on click", async () => {
+        render(<RoomCreate mxEvent={createEvent} />);
+        const link = screen.getByText("Click here to see older messages.");
+
+        await act(() => userEvent.click(link));
+
+        await waitFor(() =>
+            expect(dis.dispatch).toHaveBeenCalledWith({
+                action: Action.ViewRoom,
+                event_id: "tombstone_event_id",
+                highlighted: true,
+                room_id: "old_room_id",
+                metricsTrigger: "Predecessor",
+                metricsViaKeyboard: false,
+            }),
+        );
+    });
+});

test/components/views/messages/__snapshots__/RoomCreate-test.tsx.snap

@@ -0,0 +1,24 @@
+// Jest Snapshot v1, https://goo.gl/fbAQLP
+
+exports[`<RoomCreate /> Renders as expected 1`] = `
+<DocumentFragment>
+  <div
+    class="mx_EventTileBubble mx_CreateEvent"
+  >
+    <div
+      class="mx_EventTileBubble_title"
+    >
+      This room is a continuation of another conversation.
+    </div>
+    <div
+      class="mx_EventTileBubble_subtitle"
+    >
+      <a
+        href="https://matrix.to/#/old_room_id/tombstone_event_id"
+      >
+        Click here to see older messages.
+      </a>
+    </div>
+  </div>
+</DocumentFragment>
+`;

test/components/views/settings/tabs/room/AdvancedRoomSettingsTab-test.tsx

@@ -26,6 +26,7 @@ import { mkEvent, mkStubRoom, stubClient } from "../../../../../test-utils";
 import dis from "../../../../../../src/dispatcher/dispatcher";
 import { Action } from "../../../../../../src/dispatcher/actions";
 import { MatrixClientPeg } from "../../../../../../src/MatrixClientPeg";
+import SettingsStore from "../../../../../../src/settings/SettingsStore";
 
 jest.mock("../../../../../../src/dispatcher/dispatcher");
 
@@ -43,6 +44,12 @@ describe("AdvancedRoomSettingsTab", () => {
         cli = MatrixClientPeg.get();
         room = mkStubRoom(roomId, "test room", cli);
         mocked(cli.getRoom).mockReturnValue(room);
+        mocked(dis.dispatch).mockReset();
+        mocked(room.findPredecessor).mockImplementation((msc3946: boolean) =>
+            msc3946
+                ? { roomId: "old_room_id_via_predecessor", eventId: null }
+                : { roomId: "old_room_id", eventId: "tombstone_event_id" },
+        );
     });
 
     it("should render as expected", () => {
@@ -71,6 +78,17 @@ describe("AdvancedRoomSettingsTab", () => {
             room: room.roomId,
         });
 
+        // Because we're mocking Room.findPredecessor, it may not be necessary
+        // to provide the actual event here, but we do need the create event,
+        // and in future this may be needed, so included for symmetry.
+        const predecessorEvent = mkEvent({
+            event: true,
+            user: "@a:b.com",
+            type: EventType.RoomPredecessor,
+            content: { predecessor_room_id: "old_room_id_via_predecessor" },
+            room: room.roomId,
+        });
+
         type GetStateEvents2Args = (eventType: EventType | string, stateKey: string) => MatrixEvent | null;
 
         const getStateEvents = jest.spyOn(
@@ -82,6 +100,8 @@ describe("AdvancedRoomSettingsTab", () => {
             switch (eventType) {
                 case EventType.RoomCreate:
                     return createEvent;
+                case EventType.RoomPredecessor:
+                    return predecessorEvent;
                 default:
                     return null;
             }
@@ -101,4 +121,26 @@ describe("AdvancedRoomSettingsTab", () => {
             metricsViaKeyboard: false,
         });
     });
+
+    describe("When MSC3946 support is enabled", () => {
+        beforeEach(() => {
+            jest.spyOn(SettingsStore, "getValue")
+                .mockReset()
+                .mockImplementation((settingName) => settingName === "feature_dynamic_room_predecessors");
+        });
+
+        it("should link to predecessor room via MSC3946 if enabled", async () => {
+            mockStateEvents(room);
+            const tab = renderTab();
+            const link = await tab.findByText("View older messages in test room.");
+            fireEvent.click(link);
+            expect(dis.dispatch).toHaveBeenCalledWith({
+                action: Action.ViewRoom,
+                event_id: null,
+                room_id: "old_room_id_via_predecessor",
+                metricsTrigger: "WebPredecessorSettings",
+                metricsViaKeyboard: false,
+            });
+        });
+    });
 });