Fix wrongly asserting that PushRule::conditions is non-null (#7973)

This commit is contained in:
Michael Telatynski 2022-03-04 09:39:16 +00:00 committed by GitHub
parent b80ea34805
commit 15cbc6c26c
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
3 changed files with 91 additions and 19 deletions

View File

@ -61,17 +61,6 @@ export function aggregateNotificationCount(rooms: Room[]): {count: number, highl
}, { count: 0, highlight: false });
}
export function getRoomHasBadge(room: Room): boolean {
const roomNotifState = getRoomNotifsState(room.roomId);
const highlight = room.getUnreadNotificationCount(NotificationCountType.Highlight) > 0;
const notificationCount = room.getUnreadNotificationCount();
const notifBadges = notificationCount > 0 && shouldShowNotifBadge(roomNotifState);
const mentionBadges = highlight && shouldShowMentionBadge(roomNotifState);
return notifBadges || mentionBadges;
}
export function getRoomNotifsState(roomId: string): RoomNotifState {
if (MatrixClientPeg.get().isGuest()) return RoomNotifState.AllMessages;
@ -88,14 +77,14 @@ export function getRoomNotifsState(roomId: string): RoomNotifState {
roomRule = MatrixClientPeg.get().getRoomPushRule('global', roomId);
} catch (err) {
// Possible that the client doesn't have pushRules yet. If so, it
// hasn't started eiher, so indicate that this room is not notifying.
// hasn't started either, so indicate that this room is not notifying.
return null;
}
// XXX: We have to assume the default is to notify for all messages
// (in particular this will be 'wrong' for one to one rooms because
// they will notify loudly for all messages)
if (!roomRule || !roomRule.enabled) return RoomNotifState.AllMessages;
if (!roomRule?.enabled) return RoomNotifState.AllMessages;
// a mute at the room level will still allow mentions
// to notify
@ -213,17 +202,15 @@ function findOverrideMuteRule(roomId: string): IPushRule {
return null;
}
for (const rule of cli.pushRules.global.override) {
if (isRuleForRoom(roomId, rule)) {
if (isMuteRule(rule) && rule.enabled) {
return rule;
}
if (rule.enabled && isRuleForRoom(roomId, rule) && isMuteRule(rule)) {
return rule;
}
}
return null;
}
function isRuleForRoom(roomId: string, rule: IPushRule): boolean {
if (rule.conditions.length !== 1) {
if (rule.conditions?.length !== 1) {
return false;
}
const cond = rule.conditions[0];

85
test/RoomNotifs-test.ts Normal file
View File

@ -0,0 +1,85 @@
/*
Copyright 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 { ConditionKind, PushRuleActionName, TweakName } from "matrix-js-sdk/src/@types/PushRules";
import { stubClient } from "./test-utils";
import { MatrixClientPeg } from "../src/MatrixClientPeg";
import { getRoomNotifsState, RoomNotifState } from "../src/RoomNotifs";
describe("RoomNotifs test", () => {
beforeEach(() => {
stubClient();
});
it("getRoomNotifsState handles rules with no conditions", () => {
MatrixClientPeg.get().pushRules = {
global: {
override: [{
rule_id: "!roomId:server",
enabled: true,
default: false,
actions: [],
}],
},
};
expect(getRoomNotifsState("!roomId:server")).toBe(null);
});
it("getRoomNotifsState handles guest users", () => {
MatrixClientPeg.get().isGuest.mockReturnValue(true);
expect(getRoomNotifsState("!roomId:server")).toBe(RoomNotifState.AllMessages);
});
it("getRoomNotifsState handles mute state", () => {
MatrixClientPeg.get().pushRules = {
global: {
override: [{
rule_id: "!roomId:server",
enabled: true,
default: false,
conditions: [{
kind: ConditionKind.EventMatch,
key: "room_id",
pattern: "!roomId:server",
}],
actions: [PushRuleActionName.DontNotify],
}],
},
};
expect(getRoomNotifsState("!roomId:server")).toBe(RoomNotifState.Mute);
});
it("getRoomNotifsState handles mentions only", () => {
MatrixClientPeg.get().getRoomPushRule = () => ({
rule_id: "!roomId:server",
enabled: true,
default: false,
actions: [PushRuleActionName.DontNotify],
});
expect(getRoomNotifsState("!roomId:server")).toBe(RoomNotifState.MentionsOnly);
});
it("getRoomNotifsState handles noisy", () => {
MatrixClientPeg.get().getRoomPushRule = () => ({
rule_id: "!roomId:server",
enabled: true,
default: false,
actions: [{ set_tweak: TweakName.Sound }],
});
expect(getRoomNotifsState("!roomId:server")).toBe(RoomNotifState.AllMessagesLoud);
});
});

View File

@ -102,7 +102,7 @@ export function createTestClient() {
sendStateEvent: jest.fn().mockResolvedValue(),
getSyncState: () => "SYNCING",
generateClientSecret: () => "t35tcl1Ent5ECr3T",
isGuest: () => false,
isGuest: jest.fn().mockReturnValue(false),
isCryptoEnabled: () => false,
getRoomHierarchy: jest.fn().mockReturnValue({
rooms: [],