06c4ba32cd
* refactor: convert RoomViewStore from flux Store to standard EventEmitter Parts of a series of experimental changes to improve the design of stores. * Use a gen5 store for RoomViewStore for now due to lock handling * Revert "Use a gen5 store for RoomViewStore for now due to lock handling" This reverts commit 1076af071d997d87b8ae0b0dcddfd1ae428665af. * Add untilEmission and tweak untilDispatch; use it in RoomViewStore * Add more RVS tests; remove custom room ID listener code and use EventEmitter * Better comments * Null guard `dis` as tests mock out `defaultDispatcher` * Additional tests
279 lines
11 KiB
TypeScript
279 lines
11 KiB
TypeScript
/*
|
|
Copyright 2021 - 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 { IEventRelation, MatrixEvent } from 'matrix-js-sdk/src/models/event';
|
|
import { EventTimelineSet } from 'matrix-js-sdk/src/models/event-timeline-set';
|
|
import { NotificationCountType, Room } from 'matrix-js-sdk/src/models/room';
|
|
import { Thread } from 'matrix-js-sdk/src/models/thread';
|
|
|
|
import BaseCard from "./BaseCard";
|
|
import ResizeNotifier from '../../../utils/ResizeNotifier';
|
|
import MessageComposer from '../rooms/MessageComposer';
|
|
import { RoomPermalinkCreator } from '../../../utils/permalinks/Permalinks';
|
|
import { Layout } from '../../../settings/enums/Layout';
|
|
import TimelinePanel from '../../structures/TimelinePanel';
|
|
import { E2EStatus } from '../../../utils/ShieldUtils';
|
|
import EditorStateTransfer from '../../../utils/EditorStateTransfer';
|
|
import RoomContext, { TimelineRenderingType } from '../../../contexts/RoomContext';
|
|
import dis from '../../../dispatcher/dispatcher';
|
|
import { _t } from '../../../languageHandler';
|
|
import { ActionPayload } from '../../../dispatcher/payloads';
|
|
import { Action } from '../../../dispatcher/actions';
|
|
import { RoomViewStore } from '../../../stores/RoomViewStore';
|
|
import ContentMessages from '../../../ContentMessages';
|
|
import UploadBar from '../../structures/UploadBar';
|
|
import SettingsStore from '../../../settings/SettingsStore';
|
|
import JumpToBottomButton from '../rooms/JumpToBottomButton';
|
|
import { ViewRoomPayload } from "../../../dispatcher/payloads/ViewRoomPayload";
|
|
import Measured from '../elements/Measured';
|
|
import Heading from '../typography/Heading';
|
|
import { UPDATE_EVENT } from '../../../stores/AsyncStore';
|
|
|
|
interface IProps {
|
|
room: Room;
|
|
onClose: () => void;
|
|
resizeNotifier: ResizeNotifier;
|
|
permalinkCreator?: RoomPermalinkCreator;
|
|
e2eStatus?: E2EStatus;
|
|
classNames?: string;
|
|
timelineSet?: EventTimelineSet;
|
|
timelineRenderingType?: TimelineRenderingType;
|
|
showComposer?: boolean;
|
|
composerRelation?: IEventRelation;
|
|
}
|
|
|
|
interface IState {
|
|
thread?: Thread;
|
|
editState?: EditorStateTransfer;
|
|
replyToEvent?: MatrixEvent;
|
|
initialEventId?: string;
|
|
isInitialEventHighlighted?: boolean;
|
|
layout: Layout;
|
|
atEndOfLiveTimeline: boolean;
|
|
narrow: boolean;
|
|
|
|
// settings:
|
|
showReadReceipts?: boolean;
|
|
}
|
|
|
|
export default class TimelineCard extends React.Component<IProps, IState> {
|
|
static contextType = RoomContext;
|
|
|
|
private dispatcherRef: string;
|
|
private layoutWatcherRef: string;
|
|
private timelinePanel = React.createRef<TimelinePanel>();
|
|
private card = React.createRef<HTMLDivElement>();
|
|
private readReceiptsSettingWatcher: string;
|
|
|
|
constructor(props: IProps) {
|
|
super(props);
|
|
this.state = {
|
|
showReadReceipts: SettingsStore.getValue("showReadReceipts", props.room.roomId),
|
|
layout: SettingsStore.getValue("layout"),
|
|
atEndOfLiveTimeline: true,
|
|
narrow: false,
|
|
};
|
|
this.readReceiptsSettingWatcher = null;
|
|
}
|
|
|
|
public componentDidMount(): void {
|
|
RoomViewStore.instance.addListener(UPDATE_EVENT, this.onRoomViewStoreUpdate);
|
|
this.dispatcherRef = dis.register(this.onAction);
|
|
this.readReceiptsSettingWatcher = SettingsStore.watchSetting("showReadReceipts", null, (...[,,, value]) =>
|
|
this.setState({ showReadReceipts: value as boolean }),
|
|
);
|
|
this.layoutWatcherRef = SettingsStore.watchSetting("layout", null, (...[,,, value]) =>
|
|
this.setState({ layout: value as Layout }),
|
|
);
|
|
}
|
|
|
|
public componentWillUnmount(): void {
|
|
RoomViewStore.instance.removeListener(UPDATE_EVENT, this.onRoomViewStoreUpdate);
|
|
|
|
if (this.readReceiptsSettingWatcher) {
|
|
SettingsStore.unwatchSetting(this.readReceiptsSettingWatcher);
|
|
}
|
|
if (this.layoutWatcherRef) {
|
|
SettingsStore.unwatchSetting(this.layoutWatcherRef);
|
|
}
|
|
|
|
dis.unregister(this.dispatcherRef);
|
|
}
|
|
|
|
private onRoomViewStoreUpdate = async (initial?: boolean): Promise<void> => {
|
|
const newState: Pick<IState, any> = {
|
|
// roomLoading: RoomViewStore.instance.isRoomLoading(),
|
|
// roomLoadError: RoomViewStore.instance.getRoomLoadError(),
|
|
|
|
initialEventId: RoomViewStore.instance.getInitialEventId(),
|
|
isInitialEventHighlighted: RoomViewStore.instance.isInitialEventHighlighted(),
|
|
replyToEvent: RoomViewStore.instance.getQuotingEvent(),
|
|
};
|
|
|
|
this.setState(newState);
|
|
};
|
|
|
|
private onAction = (payload: ActionPayload): void => {
|
|
switch (payload.action) {
|
|
case Action.EditEvent:
|
|
this.setState({
|
|
editState: payload.event ? new EditorStateTransfer(payload.event) : null,
|
|
}, () => {
|
|
if (payload.event) {
|
|
this.timelinePanel.current?.scrollToEventIfNeeded(payload.event.getId());
|
|
}
|
|
});
|
|
break;
|
|
default:
|
|
break;
|
|
}
|
|
};
|
|
|
|
private onScroll = (): void => {
|
|
const timelinePanel = this.timelinePanel.current;
|
|
if (!timelinePanel) return;
|
|
if (timelinePanel.isAtEndOfLiveTimeline()) {
|
|
this.setState({
|
|
atEndOfLiveTimeline: true,
|
|
});
|
|
} else {
|
|
this.setState({
|
|
atEndOfLiveTimeline: false,
|
|
});
|
|
}
|
|
|
|
if (this.state.initialEventId && this.state.isInitialEventHighlighted) {
|
|
dis.dispatch<ViewRoomPayload>({
|
|
action: Action.ViewRoom,
|
|
room_id: this.props.room.roomId,
|
|
event_id: this.state.initialEventId,
|
|
highlighted: false,
|
|
replyingToEvent: this.state.replyToEvent,
|
|
metricsTrigger: undefined, // room doesn't change
|
|
});
|
|
}
|
|
};
|
|
|
|
private onMeasurement = (narrow: boolean): void => {
|
|
this.setState({ narrow });
|
|
};
|
|
|
|
private jumpToLiveTimeline = () => {
|
|
if (this.state.initialEventId && this.state.isInitialEventHighlighted) {
|
|
// If we were viewing a highlighted event, firing view_room without
|
|
// an event will take care of both clearing the URL fragment and
|
|
// jumping to the bottom
|
|
dis.dispatch({
|
|
action: Action.ViewRoom,
|
|
room_id: this.props.room.roomId,
|
|
});
|
|
} else {
|
|
// Otherwise we have to jump manually
|
|
this.timelinePanel.current?.jumpToLiveTimeline();
|
|
dis.fire(Action.FocusSendMessageComposer);
|
|
}
|
|
};
|
|
|
|
private renderTimelineCardHeader = (): JSX.Element => {
|
|
return <div className="mx_BaseCard_header_title">
|
|
<Heading size="h4" className="mx_BaseCard_header_title_heading">{ _t("Chat") }</Heading>
|
|
</div>;
|
|
};
|
|
|
|
public render(): JSX.Element {
|
|
const highlightedEventId = this.state.isInitialEventHighlighted
|
|
? this.state.initialEventId
|
|
: null;
|
|
|
|
let jumpToBottom;
|
|
if (!this.state.atEndOfLiveTimeline) {
|
|
jumpToBottom = (<JumpToBottomButton
|
|
highlight={this.props.room.getUnreadNotificationCount(NotificationCountType.Highlight) > 0}
|
|
onScrollToBottomClick={this.jumpToLiveTimeline}
|
|
/>);
|
|
}
|
|
|
|
const isUploading = ContentMessages.sharedInstance().getCurrentUploads(this.props.composerRelation).length > 0;
|
|
|
|
const myMembership = this.props.room.getMyMembership();
|
|
const showComposer = myMembership === "join";
|
|
|
|
return (
|
|
<RoomContext.Provider value={{
|
|
...this.context,
|
|
timelineRenderingType: this.props.timelineRenderingType ?? this.context.timelineRenderingType,
|
|
liveTimeline: this.props.timelineSet.getLiveTimeline(),
|
|
narrow: this.state.narrow,
|
|
}}>
|
|
<BaseCard
|
|
className={this.props.classNames}
|
|
onClose={this.props.onClose}
|
|
withoutScrollContainer={true}
|
|
header={this.renderTimelineCardHeader()}
|
|
ref={this.card}
|
|
>
|
|
<Measured
|
|
sensor={this.card.current}
|
|
onMeasurement={this.onMeasurement}
|
|
/>
|
|
<div className="mx_TimelineCard_timeline">
|
|
{ jumpToBottom }
|
|
<TimelinePanel
|
|
ref={this.timelinePanel}
|
|
showReadReceipts={this.state.showReadReceipts}
|
|
manageReadReceipts={true}
|
|
manageReadMarkers={false} // No RM support in the TimelineCard
|
|
sendReadReceiptOnLoad={true}
|
|
timelineSet={this.props.timelineSet}
|
|
showUrlPreview={this.context.showUrlPreview}
|
|
// The right panel timeline (and therefore threads) don't support IRC layout at this time
|
|
layout={this.state.layout === Layout.Bubble ? Layout.Bubble : Layout.Group}
|
|
hideThreadedMessages={false}
|
|
hidden={false}
|
|
showReactions={true}
|
|
className="mx_RoomView_messagePanel"
|
|
permalinkCreator={this.props.permalinkCreator}
|
|
membersLoaded={true}
|
|
editState={this.state.editState}
|
|
eventId={this.state.initialEventId}
|
|
resizeNotifier={this.props.resizeNotifier}
|
|
highlightedEventId={highlightedEventId}
|
|
onScroll={this.onScroll}
|
|
/>
|
|
</div>
|
|
|
|
{ isUploading && (
|
|
<UploadBar room={this.props.room} relation={this.props.composerRelation} />
|
|
) }
|
|
|
|
{ showComposer && (
|
|
<MessageComposer
|
|
room={this.props.room}
|
|
relation={this.props.composerRelation}
|
|
resizeNotifier={this.props.resizeNotifier}
|
|
replyToEvent={this.state.replyToEvent}
|
|
permalinkCreator={this.props.permalinkCreator}
|
|
e2eStatus={this.props.e2eStatus}
|
|
compact={true}
|
|
/>
|
|
) }
|
|
</BaseCard>
|
|
</RoomContext.Provider>
|
|
);
|
|
}
|
|
}
|