imterah/element-portable
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

Resilience fix for homeserver without thread notification support (#9565)

Browse source 
* Notification state resilience

* TypeScript strict fixes

* Add tests
This commit is contained in:
Germain 2022-11-10 18:01:19 +00:00 • committed by GitHub
parent 8ebdcab7d9
commit ee13e23b15
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
2 changed files with 30 additions and 20 deletions
Download patch file Download diff file Expand all files Collapse all files

40
src/components/views/right_panel/RoomHeaderButtons.tsx
View file

@ -30,7 +30,6 @@ import { RightPanelPhases } from '../../../stores/right-panel/RightPanelStorePha
import { Action } from "../../../dispatcher/actions"; import { Action } from "../../../dispatcher/actions";
import { ActionPayload } from "../../../dispatcher/payloads"; import { ActionPayload } from "../../../dispatcher/payloads";
import RightPanelStore from "../../../stores/right-panel/RightPanelStore"; import RightPanelStore from "../../../stores/right-panel/RightPanelStore";
import { useSettingValue } from "../../../hooks/useSettings";
import { useReadPinnedEvents, usePinnedEvents } from './PinnedMessagesCard'; import { useReadPinnedEvents, usePinnedEvents } from './PinnedMessagesCard';
import { showThreadPanel } from "../../../dispatcher/dispatch-actions/threads"; import { showThreadPanel } from "../../../dispatcher/dispatch-actions/threads";
import SettingsStore from "../../../settings/SettingsStore"; import SettingsStore from "../../../settings/SettingsStore";
@ -85,9 +84,8 @@ interface IHeaderButtonProps {
} }
const PinnedMessagesHeaderButton = ({ room, isHighlighted, onClick }: IHeaderButtonProps) => { const PinnedMessagesHeaderButton = ({ room, isHighlighted, onClick }: IHeaderButtonProps) => {
const pinningEnabled = useSettingValue("feature_pinning"); const pinnedEvents = usePinnedEvents(room);
const pinnedEvents = usePinnedEvents(pinningEnabled && room); const readPinnedEvents = useReadPinnedEvents(room);
const readPinnedEvents = useReadPinnedEvents(pinningEnabled && room);
if (!pinnedEvents?.length) return null; if (!pinnedEvents?.length) return null;
let unreadIndicator; let unreadIndicator;
@ -135,7 +133,7 @@ export default class RoomHeaderButtons extends HeaderButtons<IProps> {
RightPanelPhases.ThreadPanel, RightPanelPhases.ThreadPanel,
RightPanelPhases.ThreadView, RightPanelPhases.ThreadView,
]; ];
private threadNotificationState: ThreadsRoomNotificationState; private threadNotificationState: ThreadsRoomNotificationState | null;
private globalNotificationState: SummarizedNotificationState; private globalNotificationState: SummarizedNotificationState;
private get supportsThreadNotifications(): boolean { private get supportsThreadNotifications(): boolean {
@ -146,9 +144,9 @@ export default class RoomHeaderButtons extends HeaderButtons<IProps> {
constructor(props: IProps) { constructor(props: IProps) {
super(props, HeaderKind.Room); super(props, HeaderKind.Room);
if (!this.supportsThreadNotifications) { this.threadNotificationState = !this.supportsThreadNotifications && this.props.room
this.threadNotificationState = RoomNotificationStateStore.instance.getThreadsRoomState(this.props.room); ? RoomNotificationStateStore.instance.getThreadsRoomState(this.props.room)
} : null;
this.globalNotificationState = RoomNotificationStateStore.instance.globalState; this.globalNotificationState = RoomNotificationStateStore.instance.globalState;
} }
@ -176,7 +174,7 @@ export default class RoomHeaderButtons extends HeaderButtons<IProps> {
private onNotificationUpdate = (): void => { private onNotificationUpdate = (): void => {
let threadNotificationColor: NotificationColor; let threadNotificationColor: NotificationColor;
if (!this.supportsThreadNotifications) { if (!this.supportsThreadNotifications) {
threadNotificationColor = this.threadNotificationState.color; threadNotificationColor = this.threadNotificationState?.color ?? NotificationColor.None;
} else { } else {
threadNotificationColor = this.notificationColor; threadNotificationColor = this.notificationColor;
} }
@ -189,7 +187,7 @@ export default class RoomHeaderButtons extends HeaderButtons<IProps> {
}; };
private get notificationColor(): NotificationColor { private get notificationColor(): NotificationColor {
switch (this.props.room.threadsAggregateNotificationType) { switch (this.props.room?.threadsAggregateNotificationType) {
case NotificationCountType.Highlight: case NotificationCountType.Highlight:
return NotificationColor.Red; return NotificationColor.Red;
case NotificationCountType.Total: case NotificationCountType.Total:
@ -263,7 +261,7 @@ export default class RoomHeaderButtons extends HeaderButtons<IProps> {
private onThreadsPanelClicked = (ev: ButtonEvent) => { private onThreadsPanelClicked = (ev: ButtonEvent) => {
if (RoomHeaderButtons.THREAD_PHASES.includes(this.state.phase)) { if (RoomHeaderButtons.THREAD_PHASES.includes(this.state.phase)) {
RightPanelStore.instance.togglePanel(this.props.room?.roomId); RightPanelStore.instance.togglePanel(this.props.room?.roomId ?? null);
} else { } else {
showThreadPanel(); showThreadPanel();
PosthogTrackers.trackInteraction("WebRoomHeaderButtonsThreadsButton", ev); PosthogTrackers.trackInteraction("WebRoomHeaderButtonsThreadsButton", ev);
@ -271,15 +269,21 @@ export default class RoomHeaderButtons extends HeaderButtons<IProps> {
}; };
public renderButtons() { public renderButtons() {
if (!this.props.room) {
return <></>;
}
const rightPanelPhaseButtons: Map<RightPanelPhases, any> = new Map(); const rightPanelPhaseButtons: Map<RightPanelPhases, any> = new Map();
rightPanelPhaseButtons.set(RightPanelPhases.PinnedMessages, if (SettingsStore.getValue("feature_pinning")) {
<PinnedMessagesHeaderButton rightPanelPhaseButtons.set(RightPanelPhases.PinnedMessages,
key="pinnedMessagesButton" <PinnedMessagesHeaderButton
room={this.props.room} key="pinnedMessagesButton"
isHighlighted={this.isPhase(RightPanelPhases.PinnedMessages)} room={this.props.room}
onClick={this.onPinnedMessagesClicked} />, isHighlighted={this.isPhase(RightPanelPhases.PinnedMessages)}
); onClick={this.onPinnedMessagesClicked} />,
);
}
rightPanelPhaseButtons.set(RightPanelPhases.Timeline, rightPanelPhaseButtons.set(RightPanelPhases.Timeline,
<TimelineCardHeaderButton <TimelineCardHeaderButton
key="timelineButton" key="timelineButton"

10
test/components/views/right_panel/RoomHeaderButtons-test.tsx
View file

@ -16,6 +16,7 @@ limitations under the License.
import { render } from "@testing-library/react"; import { render } from "@testing-library/react";
import { MatrixClient, PendingEventOrdering } from "matrix-js-sdk/src/client"; import { MatrixClient, PendingEventOrdering } from "matrix-js-sdk/src/client";
import { Feature, ServerSupport } from "matrix-js-sdk/src/feature";
import { NotificationCountType, Room } from "matrix-js-sdk/src/models/room"; import { NotificationCountType, Room } from "matrix-js-sdk/src/models/room";
import React from "react"; import React from "react";
@ -34,7 +35,7 @@ describe("RoomHeaderButtons-test.tsx", function() {
stubClient(); stubClient();
client = MatrixClientPeg.get(); client = MatrixClientPeg.get();
room = new Room(ROOM_ID, client, client.getUserId(), { room = new Room(ROOM_ID, client, client.getUserId() ?? "", {
pendingEventOrdering: PendingEventOrdering.Detached, pendingEventOrdering: PendingEventOrdering.Detached,
}); });
@ -43,7 +44,7 @@ describe("RoomHeaderButtons-test.tsx", function() {
}); });
}); });
function getComponent(room: Room) { function getComponent(room?: Room) {
return render(<RoomHeaderButtons return render(<RoomHeaderButtons
room={room} room={room}
excludedRightPanelPhaseButtons={[]} excludedRightPanelPhaseButtons={[]}
@ -94,4 +95,9 @@ describe("RoomHeaderButtons-test.tsx", function() {
expect(container.querySelector(".mx_RightPanel_threadsButton .mx_Indicator")).toBeNull(); expect(container.querySelector(".mx_RightPanel_threadsButton .mx_Indicator")).toBeNull();
}); });
it("does not explode without a room", () => {
client.canSupport.set(Feature.ThreadUnreadNotifications, ServerSupport.Unsupported);
expect(() => getComponent()).not.toThrow();
});
}); });