Ask to refresh timeline when historical messages are imported (MSC2716)

res/css/structures/_RoomStatusBar.scss

@@ -145,6 +145,12 @@ limitations under the License.
                     mask-image: url('$(res)/img/element-icons/retry.svg');
                 }
             }
+
+            &.mx_RoomStatusBar_refreshTimelineBtn {
+                &::before {
+                    mask-image: url('$(res)/img/element-icons/retry.svg');
+                }
+            }
         }
 
         .mx_InlineSpinner {

src/components/structures/FilePanel.tsx

@@ -104,7 +104,9 @@ class FilePanel extends React.Component<IProps, IState> {
         }
 
         if (!this.state.timelineSet.eventIdToTimeline(ev.getId())) {
-            this.state.timelineSet.addEventToTimeline(ev, timeline, false);
+            this.state.timelineSet.addEventToTimeline(ev, timeline, {
+                toStartOfTimeline: false,
+            });
         }
     }
 

src/components/structures/RoomStatusBar.tsx

@@ -17,7 +17,7 @@ limitations under the License.
 import React from 'react';
 import { EventStatus, MatrixEvent } from "matrix-js-sdk/src/models/event";
 import { SyncState, ISyncStateData } from "matrix-js-sdk/src/sync";
-import { Room } from "matrix-js-sdk/src/models/room";
+import { Room, RoomEvent } from "matrix-js-sdk/src/models/room";
 
 import { _t, _td } from '../../languageHandler';
 import Resend from '../../Resend';
@@ -79,6 +79,7 @@ interface IState {
     syncStateData: ISyncStateData;
     unsentMessages: MatrixEvent[];
     isResending: boolean;
+    timelineNeedsRefresh: boolean;
 }
 
 export default class RoomStatusBar extends React.PureComponent<IProps, IState> {
@@ -93,19 +94,30 @@ export default class RoomStatusBar extends React.PureComponent<IProps, IState> {
             syncStateData: this.context.getSyncStateData(),
             unsentMessages: getUnsentMessages(this.props.room),
             isResending: false,
+            timelineNeedsRefresh: this.props.room.getTimelineNeedsRefresh(),
         };
     }
 
     public componentDidMount(): void {
         const client = this.context;
         client.on("sync", this.onSyncStateChange);
         client.on("Room.localEchoUpdated", this.onRoomLocalEchoUpdated);
+        this.props.room.on(RoomEvent.historyImportedWithinTimeline, this.onRoomHistoryImportedWithinTimeline);
 
         this.checkSize();
     }
 
-    public componentDidUpdate(): void {
+    public componentDidUpdate(prevProps): void {
         this.checkSize();
+
+        // When the room changes, setup the new listener
+        if (prevProps.room !== this.props.room) {
+            prevProps.room.removeListener(
+                "Room.historyImportedWithinTimeline",
+                this.onRoomHistoryImportedWithinTimeline,
+            );
+            this.props.room.on(RoomEvent.historyImportedWithinTimeline, this.onRoomHistoryImportedWithinTimeline);
+        }
     }
 
     public componentWillUnmount(): void {
@@ -116,6 +128,11 @@ export default class RoomStatusBar extends React.PureComponent<IProps, IState> {
             client.removeListener("sync", this.onSyncStateChange);
             client.removeListener("Room.localEchoUpdated", this.onRoomLocalEchoUpdated);
         }
+
+        this.props.room.removeListener(
+            RoomEvent.historyImportedWithinTimeline,
+            this.onRoomHistoryImportedWithinTimeline,
+        );
     }
 
     private onSyncStateChange = (state: SyncState, prevState: SyncState, data: ISyncStateData): void => {
@@ -142,6 +159,15 @@ export default class RoomStatusBar extends React.PureComponent<IProps, IState> {
         dis.fire(Action.FocusSendMessageComposer);
     };
 
+    private onRefreshTimelineClick = (): void => {
+        // Empty out the current timeline and re-request it
+        this.props.room.refreshLiveTimeline();
+
+        this.setState({
+            timelineNeedsRefresh: false,
+        });
+    };
+
     private onRoomLocalEchoUpdated = (ev: MatrixEvent, room: Room) => {
         if (room.roomId !== this.props.room.roomId) return;
         const messages = getUnsentMessages(this.props.room);
@@ -151,6 +177,14 @@ export default class RoomStatusBar extends React.PureComponent<IProps, IState> {
         });
     };
 
+    private onRoomHistoryImportedWithinTimeline = (markerEv: MatrixEvent, room: Room) => {
+        if (room.roomId !== this.props.room.roomId) return;
+
+        this.setState({
+            timelineNeedsRefresh: room.getTimelineNeedsRefresh(),
+        });
+    };
+
     // Check whether current size is greater than 0, if yes call props.onVisible
     private checkSize(): void {
         if (this.getSize()) {
@@ -166,7 +200,11 @@ export default class RoomStatusBar extends React.PureComponent<IProps, IState> {
     private getSize(): number {
         if (this.shouldShowConnectionError()) {
             return STATUS_BAR_EXPANDED;
-        } else if (this.state.unsentMessages.length > 0 || this.state.isResending) {
+        } else if (
+            this.state.unsentMessages.length > 0 ||
+            this.state.isResending ||
+            this.state.timelineNeedsRefresh
+        ) {
             return STATUS_BAR_EXPANDED_LARGE;
         }
         return STATUS_BAR_HIDDEN;
@@ -286,8 +324,7 @@ export default class RoomStatusBar extends React.PureComponent<IProps, IState> {
                                 src={require("../../../res/img/feather-customised/warning-triangle.svg").default}
                                 width="24"
                                 height="24"
-                                title="/!\ "
-                                alt="/!\ " />
+                                alt="" />
                             <div>
                                 <div className="mx_RoomStatusBar_connectionLostBar_title">
                                     { _t('Connectivity to the server has been lost.') }
@@ -306,6 +343,36 @@ export default class RoomStatusBar extends React.PureComponent<IProps, IState> {
             return this.getUnsentMessageContent();
         }
 
+        if (this.state.timelineNeedsRefresh) {
+            return (
+                <div className="mx_RoomStatusBar mx_RoomStatusBar_unsentMessages">
+                    <div role="alert">
+                        <div className="mx_RoomStatusBar_unsentBadge">
+                            <img
+                                src={require("../../../res/img/feather-customised/warning-triangle.svg").default}
+                                width="24"
+                                height="24"
+                                alt="" />
+                        </div>
+                        <div>
+                            <div className="mx_RoomStatusBar_unsentTitle">
+                                { _t("History import detected.") }
+                            </div>
+                            <div className="mx_RoomStatusBar_unsentDescription">
+                                { _t("History was just imported somewhere in the room. " +
+                                    "In order to see the historical messages, refresh your timeline.") }
+                            </div>
+                        </div>
+                        <div className="mx_RoomStatusBar_unsentButtonBar">
+                            <AccessibleButton onClick={this.onRefreshTimelineClick} className="mx_RoomStatusBar_refreshTimelineBtn">
+                                { _t("Refresh timeline") }
+                            </AccessibleButton>
+                        </div>
+                    </div>
+                </div>
+            );
+        }
+
         return null;
     }
 }

src/components/structures/TimelinePanel.tsx

@@ -280,6 +280,7 @@ class TimelinePanel extends React.Component<IProps, IState> {
         const cli = MatrixClientPeg.get();
         cli.on(RoomEvent.Timeline, this.onRoomTimeline);
         cli.on(RoomEvent.TimelineReset, this.onRoomTimelineReset);
+        this.props.timelineSet.room.on(RoomEvent.TimelineRefresh, this.onRoomTimelineRefresh);
         cli.on(RoomEvent.Redaction, this.onRoomRedaction);
         if (SettingsStore.getValue("feature_msc3531_hide_messages_pending_moderation")) {
             // Make sure that events are re-rendered when their visibility-pending-moderation changes.
@@ -338,6 +339,14 @@ class TimelinePanel extends React.Component<IProps, IState> {
         }
     }
 
+    public componentDidUpdate(prevProps): void {
+        // When the room changes, setup the new listener
+        if (prevProps.timelineSet.room !== this.props.timelineSet.room) {
+            prevProps.timelineSet.room.removeListener(RoomEvent.TimelineRefresh, this.onRoomTimelineRefresh);
+            this.props.timelineSet.room.on(RoomEvent.TimelineRefresh, this.onRoomTimelineRefresh);
+        }
+    }
+
     componentWillUnmount() {
         // set a boolean to say we've been unmounted, which any pending
         // promises can use to throw away their results.
@@ -370,6 +379,8 @@ class TimelinePanel extends React.Component<IProps, IState> {
             client.removeListener(MatrixEventEvent.VisibilityChange, this.onEventVisibilityChange);
             client.removeListener(ClientEvent.Sync, this.onSync);
         }
+
+        this.props.timelineSet.room.removeListener(RoomEvent.TimelineRefresh, this.onRoomTimelineRefresh);
     }
 
     private onMessageListUnfillRequest = (backwards: boolean, scrollToken: string): void => {
@@ -627,10 +638,21 @@ class TimelinePanel extends React.Component<IProps, IState> {
         });
     };
 
+    private onRoomTimelineRefresh = (room: Room, timelineSet: EventTimelineSet): void => {
+        debuglog(`onRoomTimelineRefresh skipping=${timelineSet !== this.props.timelineSet}`);
+        if (timelineSet !== this.props.timelineSet) return;
+
+        this.refreshTimeline();
+    };
+
     private onRoomTimelineReset = (room: Room, timelineSet: EventTimelineSet): void => {
+        debuglog(
+            `onRoomTimelineReset skipping=${timelineSet !== this.props.timelineSet} ` +
+            `skippingBecauseAtBottom=${this.canResetTimeline()}`,
+        );
         if (timelineSet !== this.props.timelineSet) return;
 
-        if (this.messagePanel.current && this.messagePanel.current.isAtBottom()) {
+        if (this.canResetTimeline()) {
             this.loadTimeline();
         }
     };

src/i18n/strings/en_EN.json

@@ -3058,6 +3058,9 @@
     "You can select all or individual messages to retry or delete": "You can select all or individual messages to retry or delete",
     "Connectivity to the server has been lost.": "Connectivity to the server has been lost.",
     "Sent messages will be stored until your connection has returned.": "Sent messages will be stored until your connection has returned.",
+    "History import detected.": "History import detected.",
+    "History was just imported somewhere in the room. In order to see the historical messages, refresh your timeline.": "History was just imported somewhere in the room. In order to see the historical messages, refresh your timeline.",
+    "Refresh timeline": "Refresh timeline",
     "You seem to be uploading files, are you sure you want to quit?": "You seem to be uploading files, are you sure you want to quit?",
     "You seem to be in a call, are you sure you want to quit?": "You seem to be in a call, are you sure you want to quit?",
     "Search failed": "Search failed",

src/indexing/EventIndex.ts

@@ -808,7 +808,9 @@ export default class EventIndex extends EventEmitter {
         // Add the events to the timeline of the file panel.
         matrixEvents.forEach(e => {
             if (!timelineSet.eventIdToTimeline(e.getId())) {
-                timelineSet.addEventToTimeline(e, timeline, direction == EventTimeline.BACKWARDS);
+                timelineSet.addEventToTimeline(e, timeline, {
+                    toStartOfTimeline: direction == EventTimeline.BACKWARDS,
+                });
             }
         });