You've already forked matrix-js-sdk
mirror of
https://github.com/matrix-org/matrix-js-sdk.git
synced 2025-07-31 15:24:23 +03:00
Add .m.rule.is_room_mention push rule to DEFAULT_OVERRIDE_RULES (#4100)
* Add intentional mentions push rules to DEFAULT_OVERRIDE_RULES Signed-off-by: Michael Telatynski <7t3chguy@gmail.com> * Iterate Signed-off-by: Michael Telatynski <7t3chguy@gmail.com> * Iterate Signed-off-by: Michael Telatynski <7t3chguy@gmail.com> * Iterate Signed-off-by: Michael Telatynski <7t3chguy@gmail.com> * Iterate Signed-off-by: Michael Telatynski <7t3chguy@gmail.com> --------- Signed-off-by: Michael Telatynski <7t3chguy@gmail.com>
This commit is contained in:
Michael Telatynski
committed by
GitHub
GitHub
parent
51ebd2fcde
commit
3031152444
@ -29,147 +29,150 @@ describe("NotificationService", function () {
|
|||||||
actions: ["notify", { set_tweak: "sound", value: "default" }],
|
actions: ["notify", { set_tweak: "sound", value: "default" }],
|
||||||
};
|
};
|
||||||
|
|
||||||
// These would be better if individual rules were configured in the tests themselves.
|
let matrixClient: MatrixClient;
|
||||||
const matrixClient = {
|
|
||||||
getRoom: function () {
|
|
||||||
return {
|
|
||||||
currentState: {
|
|
||||||
getMember: function () {
|
|
||||||
return {
|
|
||||||
name: testDisplayName,
|
|
||||||
};
|
|
||||||
},
|
|
||||||
getJoinedMemberCount: function () {
|
|
||||||
return 0;
|
|
||||||
},
|
|
||||||
members: {},
|
|
||||||
},
|
|
||||||
};
|
|
||||||
},
|
|
||||||
...mockClientMethodsUser(testUserId),
|
|
||||||
supportsIntentionalMentions: () => true,
|
|
||||||
pushRules: {
|
|
||||||
device: {},
|
|
||||||
global: {
|
|
||||||
content: [
|
|
||||||
{
|
|
||||||
actions: [
|
|
||||||
"notify",
|
|
||||||
{
|
|
||||||
set_tweak: "sound",
|
|
||||||
value: "default",
|
|
||||||
},
|
|
||||||
{
|
|
||||||
set_tweak: "highlight",
|
|
||||||
},
|
|
||||||
],
|
|
||||||
enabled: true,
|
|
||||||
pattern: "ali",
|
|
||||||
rule_id: ".m.rule.contains_user_name",
|
|
||||||
},
|
|
||||||
{
|
|
||||||
actions: [
|
|
||||||
"notify",
|
|
||||||
{
|
|
||||||
set_tweak: "sound",
|
|
||||||
value: "default",
|
|
||||||
},
|
|
||||||
{
|
|
||||||
set_tweak: "highlight",
|
|
||||||
},
|
|
||||||
],
|
|
||||||
enabled: true,
|
|
||||||
pattern: "coffee",
|
|
||||||
rule_id: "coffee",
|
|
||||||
},
|
|
||||||
{
|
|
||||||
actions: [
|
|
||||||
"notify",
|
|
||||||
{
|
|
||||||
set_tweak: "sound",
|
|
||||||
value: "default",
|
|
||||||
},
|
|
||||||
{
|
|
||||||
set_tweak: "highlight",
|
|
||||||
},
|
|
||||||
],
|
|
||||||
enabled: true,
|
|
||||||
pattern: "foo*bar",
|
|
||||||
rule_id: "foobar",
|
|
||||||
},
|
|
||||||
],
|
|
||||||
override: [
|
|
||||||
{
|
|
||||||
actions: [
|
|
||||||
"notify",
|
|
||||||
{
|
|
||||||
set_tweak: "sound",
|
|
||||||
value: "default",
|
|
||||||
},
|
|
||||||
{
|
|
||||||
set_tweak: "highlight",
|
|
||||||
},
|
|
||||||
],
|
|
||||||
conditions: [
|
|
||||||
{
|
|
||||||
kind: "contains_display_name",
|
|
||||||
},
|
|
||||||
],
|
|
||||||
enabled: true,
|
|
||||||
rule_id: ".m.rule.contains_display_name",
|
|
||||||
},
|
|
||||||
{
|
|
||||||
actions: [
|
|
||||||
"notify",
|
|
||||||
{
|
|
||||||
set_tweak: "sound",
|
|
||||||
value: "default",
|
|
||||||
},
|
|
||||||
],
|
|
||||||
conditions: [
|
|
||||||
{
|
|
||||||
is: "2",
|
|
||||||
kind: "room_member_count",
|
|
||||||
},
|
|
||||||
],
|
|
||||||
enabled: true,
|
|
||||||
rule_id: ".m.rule.room_one_to_one",
|
|
||||||
},
|
|
||||||
],
|
|
||||||
room: [],
|
|
||||||
sender: [],
|
|
||||||
underride: [
|
|
||||||
msc3914RoomCallRule,
|
|
||||||
{
|
|
||||||
actions: ["dont-notify"],
|
|
||||||
conditions: [
|
|
||||||
{
|
|
||||||
key: "content.msgtype",
|
|
||||||
kind: "event_match",
|
|
||||||
pattern: "m.notice",
|
|
||||||
},
|
|
||||||
],
|
|
||||||
enabled: true,
|
|
||||||
rule_id: ".m.rule.suppress_notices",
|
|
||||||
},
|
|
||||||
{
|
|
||||||
actions: [
|
|
||||||
"notify",
|
|
||||||
{
|
|
||||||
set_tweak: "highlight",
|
|
||||||
value: false,
|
|
||||||
},
|
|
||||||
],
|
|
||||||
conditions: [],
|
|
||||||
enabled: true,
|
|
||||||
rule_id: ".m.rule.fallback",
|
|
||||||
},
|
|
||||||
],
|
|
||||||
},
|
|
||||||
},
|
|
||||||
} as unknown as MatrixClient;
|
|
||||||
|
|
||||||
beforeEach(function () {
|
beforeEach(function () {
|
||||||
|
// These would be better if individual rules were configured in the tests themselves.
|
||||||
|
matrixClient = {
|
||||||
|
getRoom: function () {
|
||||||
|
return {
|
||||||
|
currentState: {
|
||||||
|
getMember: function () {
|
||||||
|
return {
|
||||||
|
name: testDisplayName,
|
||||||
|
};
|
||||||
|
},
|
||||||
|
getJoinedMemberCount: function () {
|
||||||
|
return 0;
|
||||||
|
},
|
||||||
|
members: {},
|
||||||
|
},
|
||||||
|
};
|
||||||
|
},
|
||||||
|
...mockClientMethodsUser(testUserId),
|
||||||
|
supportsIntentionalMentions: () => true,
|
||||||
|
pushRules: {
|
||||||
|
device: {},
|
||||||
|
global: {
|
||||||
|
content: [
|
||||||
|
{
|
||||||
|
actions: [
|
||||||
|
"notify",
|
||||||
|
{
|
||||||
|
set_tweak: "sound",
|
||||||
|
value: "default",
|
||||||
|
},
|
||||||
|
{
|
||||||
|
set_tweak: "highlight",
|
||||||
|
},
|
||||||
|
],
|
||||||
|
enabled: true,
|
||||||
|
pattern: "ali",
|
||||||
|
rule_id: ".m.rule.contains_user_name",
|
||||||
|
},
|
||||||
|
{
|
||||||
|
actions: [
|
||||||
|
"notify",
|
||||||
|
{
|
||||||
|
set_tweak: "sound",
|
||||||
|
value: "default",
|
||||||
|
},
|
||||||
|
{
|
||||||
|
set_tweak: "highlight",
|
||||||
|
},
|
||||||
|
],
|
||||||
|
enabled: true,
|
||||||
|
pattern: "coffee",
|
||||||
|
rule_id: "coffee",
|
||||||
|
},
|
||||||
|
{
|
||||||
|
actions: [
|
||||||
|
"notify",
|
||||||
|
{
|
||||||
|
set_tweak: "sound",
|
||||||
|
value: "default",
|
||||||
|
},
|
||||||
|
{
|
||||||
|
set_tweak: "highlight",
|
||||||
|
},
|
||||||
|
],
|
||||||
|
enabled: true,
|
||||||
|
pattern: "foo*bar",
|
||||||
|
rule_id: "foobar",
|
||||||
|
},
|
||||||
|
],
|
||||||
|
override: [
|
||||||
|
{
|
||||||
|
actions: [
|
||||||
|
"notify",
|
||||||
|
{
|
||||||
|
set_tweak: "sound",
|
||||||
|
value: "default",
|
||||||
|
},
|
||||||
|
{
|
||||||
|
set_tweak: "highlight",
|
||||||
|
},
|
||||||
|
],
|
||||||
|
conditions: [
|
||||||
|
{
|
||||||
|
kind: "contains_display_name",
|
||||||
|
},
|
||||||
|
],
|
||||||
|
enabled: true,
|
||||||
|
default: true,
|
||||||
|
rule_id: ".m.rule.contains_display_name",
|
||||||
|
},
|
||||||
|
{
|
||||||
|
actions: [
|
||||||
|
"notify",
|
||||||
|
{
|
||||||
|
set_tweak: "sound",
|
||||||
|
value: "default",
|
||||||
|
},
|
||||||
|
],
|
||||||
|
conditions: [
|
||||||
|
{
|
||||||
|
is: "2",
|
||||||
|
kind: "room_member_count",
|
||||||
|
},
|
||||||
|
],
|
||||||
|
enabled: true,
|
||||||
|
rule_id: ".m.rule.room_one_to_one",
|
||||||
|
},
|
||||||
|
],
|
||||||
|
room: [],
|
||||||
|
sender: [],
|
||||||
|
underride: [
|
||||||
|
msc3914RoomCallRule,
|
||||||
|
{
|
||||||
|
actions: ["dont-notify"],
|
||||||
|
conditions: [
|
||||||
|
{
|
||||||
|
key: "content.msgtype",
|
||||||
|
kind: "event_match",
|
||||||
|
pattern: "m.notice",
|
||||||
|
},
|
||||||
|
],
|
||||||
|
enabled: true,
|
||||||
|
rule_id: ".m.rule.suppress_notices",
|
||||||
|
},
|
||||||
|
{
|
||||||
|
actions: [
|
||||||
|
"notify",
|
||||||
|
{
|
||||||
|
set_tweak: "highlight",
|
||||||
|
value: false,
|
||||||
|
},
|
||||||
|
],
|
||||||
|
conditions: [],
|
||||||
|
enabled: true,
|
||||||
|
rule_id: ".m.rule.fallback",
|
||||||
|
},
|
||||||
|
],
|
||||||
|
},
|
||||||
|
},
|
||||||
|
} as unknown as MatrixClient;
|
||||||
|
|
||||||
testEvent = utils.mkEvent({
|
testEvent = utils.mkEvent({
|
||||||
type: "m.room.message",
|
type: "m.room.message",
|
||||||
room: testRoomId,
|
room: testRoomId,
|
||||||
@ -184,6 +187,26 @@ describe("NotificationService", function () {
|
|||||||
pushProcessor = new PushProcessor(matrixClient);
|
pushProcessor = new PushProcessor(matrixClient);
|
||||||
});
|
});
|
||||||
|
|
||||||
|
it("should add default rules in the correct order", () => {
|
||||||
|
// By the time we get here, we expect the PushProcessor to have merged the new .m.rule.is_room_mention rule into the existing list of rules.
|
||||||
|
// Check that has happened, and that it is in the right place.
|
||||||
|
const containsDisplayNameRuleIdx = matrixClient.pushRules?.global.override?.findIndex(
|
||||||
|
(rule) => rule.rule_id === RuleId.ContainsDisplayName,
|
||||||
|
);
|
||||||
|
expect(containsDisplayNameRuleIdx).toBeGreaterThan(-1);
|
||||||
|
const isRoomMentionRuleIdx = matrixClient.pushRules?.global.override?.findIndex(
|
||||||
|
(rule) => rule.rule_id === RuleId.IsRoomMention,
|
||||||
|
);
|
||||||
|
expect(isRoomMentionRuleIdx).toBeGreaterThan(-1);
|
||||||
|
const mReactionRuleIdx = matrixClient.pushRules?.global.override?.findIndex(
|
||||||
|
(rule) => rule.rule_id === ".m.rule.reaction",
|
||||||
|
);
|
||||||
|
expect(mReactionRuleIdx).toBeGreaterThan(-1);
|
||||||
|
|
||||||
|
expect(containsDisplayNameRuleIdx).toBeLessThan(isRoomMentionRuleIdx!);
|
||||||
|
expect(isRoomMentionRuleIdx).toBeLessThan(mReactionRuleIdx!);
|
||||||
|
});
|
||||||
|
|
||||||
// User IDs
|
// User IDs
|
||||||
|
|
||||||
it("should bing on a user ID.", function () {
|
it("should bing on a user ID.", function () {
|
||||||
|
|||||||
@ -56,8 +56,31 @@ const RULEKINDS_IN_ORDER = [
|
|||||||
// more details.
|
// more details.
|
||||||
// 2. We often want to start using push rules ahead of the server supporting them,
|
// 2. We often want to start using push rules ahead of the server supporting them,
|
||||||
// and so we can put them here.
|
// and so we can put them here.
|
||||||
const DEFAULT_OVERRIDE_RULES: IPushRule[] = [
|
const DEFAULT_OVERRIDE_RULES: Record<string, IPushRule> = {
|
||||||
{
|
".m.rule.is_room_mention": {
|
||||||
|
// Matrix v1.7
|
||||||
|
rule_id: ".m.rule.is_room_mention",
|
||||||
|
default: true,
|
||||||
|
enabled: true,
|
||||||
|
conditions: [
|
||||||
|
{
|
||||||
|
kind: ConditionKind.EventPropertyIs,
|
||||||
|
key: "content.m\\.mentions.room",
|
||||||
|
value: true,
|
||||||
|
},
|
||||||
|
{
|
||||||
|
kind: ConditionKind.SenderNotificationPermission,
|
||||||
|
key: "room",
|
||||||
|
},
|
||||||
|
],
|
||||||
|
actions: [
|
||||||
|
PushRuleActionName.Notify,
|
||||||
|
{
|
||||||
|
set_tweak: TweakName.Highlight,
|
||||||
|
},
|
||||||
|
],
|
||||||
|
},
|
||||||
|
".m.rule.reaction": {
|
||||||
// For homeservers which don't support MSC2153 yet
|
// For homeservers which don't support MSC2153 yet
|
||||||
rule_id: ".m.rule.reaction",
|
rule_id: ".m.rule.reaction",
|
||||||
default: true,
|
default: true,
|
||||||
@ -71,7 +94,7 @@ const DEFAULT_OVERRIDE_RULES: IPushRule[] = [
|
|||||||
],
|
],
|
||||||
actions: [PushRuleActionName.DontNotify],
|
actions: [PushRuleActionName.DontNotify],
|
||||||
},
|
},
|
||||||
{
|
".org.matrix.msc3786.rule.room.server_acl": {
|
||||||
// For homeservers which don't support MSC3786 yet
|
// For homeservers which don't support MSC3786 yet
|
||||||
rule_id: ".org.matrix.msc3786.rule.room.server_acl",
|
rule_id: ".org.matrix.msc3786.rule.room.server_acl",
|
||||||
default: true,
|
default: true,
|
||||||
@ -90,10 +113,26 @@ const DEFAULT_OVERRIDE_RULES: IPushRule[] = [
|
|||||||
],
|
],
|
||||||
actions: [],
|
actions: [],
|
||||||
},
|
},
|
||||||
|
};
|
||||||
|
|
||||||
|
const EXPECTED_DEFAULT_OVERRIDE_RULE_IDS = [
|
||||||
|
RuleId.Master,
|
||||||
|
RuleId.SuppressNotices,
|
||||||
|
RuleId.InviteToSelf,
|
||||||
|
RuleId.MemberEvent,
|
||||||
|
RuleId.IsUserMention,
|
||||||
|
RuleId.ContainsDisplayName,
|
||||||
|
RuleId.IsRoomMention,
|
||||||
|
RuleId.AtRoomNotification,
|
||||||
|
RuleId.Tombstone,
|
||||||
|
".m.rule.reaction",
|
||||||
|
".m.rule.room.server_acl",
|
||||||
|
".org.matrix.msc3786.rule.room.server_acl",
|
||||||
|
".m.rule.suppress_edits",
|
||||||
];
|
];
|
||||||
|
|
||||||
const DEFAULT_UNDERRIDE_RULES: IPushRule[] = [
|
const DEFAULT_UNDERRIDE_RULES: Record<string, IPushRule> = {
|
||||||
{
|
".org.matrix.msc3914.rule.room.call": {
|
||||||
// For homeservers which don't support MSC3914 yet
|
// For homeservers which don't support MSC3914 yet
|
||||||
rule_id: ".org.matrix.msc3914.rule.room.call",
|
rule_id: ".org.matrix.msc3914.rule.room.call",
|
||||||
default: true,
|
default: true,
|
||||||
@ -110,8 +149,74 @@ const DEFAULT_UNDERRIDE_RULES: IPushRule[] = [
|
|||||||
],
|
],
|
||||||
actions: [PushRuleActionName.Notify, { set_tweak: TweakName.Sound, value: "default" }],
|
actions: [PushRuleActionName.Notify, { set_tweak: TweakName.Sound, value: "default" }],
|
||||||
},
|
},
|
||||||
|
};
|
||||||
|
|
||||||
|
const EXPECTED_DEFAULT_UNDERRIDE_RULE_IDS = [
|
||||||
|
RuleId.IncomingCall,
|
||||||
|
RuleId.EncryptedDM,
|
||||||
|
RuleId.DM,
|
||||||
|
RuleId.Message,
|
||||||
|
RuleId.EncryptedMessage,
|
||||||
];
|
];
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Make sure that each of the rules listed in `defaultRuleIds` is listed in the given set of push rules.
|
||||||
|
*
|
||||||
|
* @param incomingRules - the existing set of known push rules for the user.
|
||||||
|
* @param defaultRules - a lookup table for the default definitions of push rules.
|
||||||
|
* @param defaultRuleIds - the IDs of the expected default push rules, in order.
|
||||||
|
*
|
||||||
|
* @returns A copy of `incomingRules`, with any missing default rules inserted in the right place.
|
||||||
|
*/
|
||||||
|
function mergeRulesWithDefaults(
|
||||||
|
incomingRules: IPushRule[],
|
||||||
|
defaultRules: Record<string, IPushRule>,
|
||||||
|
defaultRuleIds: string[],
|
||||||
|
): IPushRule[] {
|
||||||
|
// Calculate the index after the last default rule in `incomingRules`
|
||||||
|
// to allow us to split the incomingRules into defaults and custom
|
||||||
|
let firstCustomRuleIndex = incomingRules.findIndex((r) => !r.default);
|
||||||
|
if (firstCustomRuleIndex < 0) firstCustomRuleIndex = incomingRules.length;
|
||||||
|
|
||||||
|
function insertDefaultPushRule(ruleId: string): void {
|
||||||
|
if (ruleId in defaultRules) {
|
||||||
|
logger.warn(`Adding default global push rule ${ruleId}`);
|
||||||
|
newRules.push(defaultRules[ruleId]);
|
||||||
|
} else {
|
||||||
|
logger.warn(`Missing default global push rule ${ruleId}`);
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
let nextExpectedRuleIdIndex = 0;
|
||||||
|
const newRules: IPushRule[] = [];
|
||||||
|
for (const rule of incomingRules.slice(0, firstCustomRuleIndex)) {
|
||||||
|
const ruleIndex = defaultRuleIds.indexOf(rule.rule_id);
|
||||||
|
if (ruleIndex === -1) {
|
||||||
|
// an unrecognised rule; copy it over
|
||||||
|
newRules.push(rule);
|
||||||
|
continue;
|
||||||
|
}
|
||||||
|
while (ruleIndex > nextExpectedRuleIdIndex) {
|
||||||
|
// insert new rules
|
||||||
|
const defaultRuleId = defaultRuleIds[nextExpectedRuleIdIndex];
|
||||||
|
insertDefaultPushRule(defaultRuleId);
|
||||||
|
nextExpectedRuleIdIndex += 1;
|
||||||
|
}
|
||||||
|
// copy over the existing rule
|
||||||
|
newRules.push(rule);
|
||||||
|
nextExpectedRuleIdIndex += 1;
|
||||||
|
}
|
||||||
|
|
||||||
|
// Now copy over any remaining default rules
|
||||||
|
for (const ruleId of defaultRuleIds.slice(nextExpectedRuleIdIndex)) {
|
||||||
|
insertDefaultPushRule(ruleId);
|
||||||
|
}
|
||||||
|
|
||||||
|
// Finally any non-default rules that were in `incomingRules`
|
||||||
|
newRules.push(...incomingRules.slice(firstCustomRuleIndex));
|
||||||
|
return newRules;
|
||||||
|
}
|
||||||
|
|
||||||
export interface IActionsObject {
|
export interface IActionsObject {
|
||||||
/** Whether this event should notify the user or not. */
|
/** Whether this event should notify the user or not. */
|
||||||
notify: boolean;
|
notify: boolean;
|
||||||
@ -175,53 +280,17 @@ export class PushProcessor {
|
|||||||
if (!newRules.global.underride) newRules.global.underride = [];
|
if (!newRules.global.underride) newRules.global.underride = [];
|
||||||
|
|
||||||
// Merge the client-level defaults with the ones from the server
|
// Merge the client-level defaults with the ones from the server
|
||||||
const globalOverrides = newRules.global.override;
|
newRules.global.override = mergeRulesWithDefaults(
|
||||||
for (const originalOverride of DEFAULT_OVERRIDE_RULES) {
|
newRules.global.override,
|
||||||
const existingRule = globalOverrides.find((r) => r.rule_id === originalOverride.rule_id);
|
DEFAULT_OVERRIDE_RULES,
|
||||||
|
EXPECTED_DEFAULT_OVERRIDE_RULE_IDS,
|
||||||
|
);
|
||||||
|
|
||||||
// Dynamically add the user ID as the value for the is_user_mention rule.
|
newRules.global.underride = mergeRulesWithDefaults(
|
||||||
let override: IPushRule;
|
newRules.global.underride,
|
||||||
if (originalOverride.rule_id === RuleId.IsUserMention) {
|
DEFAULT_UNDERRIDE_RULES,
|
||||||
// If the user ID wasn't provided, skip the rule.
|
EXPECTED_DEFAULT_UNDERRIDE_RULE_IDS,
|
||||||
if (!userId) {
|
);
|
||||||
continue;
|
|
||||||
}
|
|
||||||
|
|
||||||
override = JSON.parse(JSON.stringify(originalOverride)); // deep clone
|
|
||||||
override.conditions![0].value = userId;
|
|
||||||
} else {
|
|
||||||
override = originalOverride;
|
|
||||||
}
|
|
||||||
|
|
||||||
if (existingRule) {
|
|
||||||
// Copy over the actions, default, and conditions. Don't touch the user's preference.
|
|
||||||
existingRule.default = override.default;
|
|
||||||
existingRule.conditions = override.conditions;
|
|
||||||
existingRule.actions = override.actions;
|
|
||||||
} else {
|
|
||||||
// Add the rule
|
|
||||||
const ruleId = override.rule_id;
|
|
||||||
logger.warn(`Adding default global override for ${ruleId}`);
|
|
||||||
globalOverrides.push(override);
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
const globalUnderrides = newRules.global.underride ?? [];
|
|
||||||
for (const underride of DEFAULT_UNDERRIDE_RULES) {
|
|
||||||
const existingRule = globalUnderrides.find((r) => r.rule_id === underride.rule_id);
|
|
||||||
|
|
||||||
if (existingRule) {
|
|
||||||
// Copy over the actions, default, and conditions. Don't touch the user's preference.
|
|
||||||
existingRule.default = underride.default;
|
|
||||||
existingRule.conditions = underride.conditions;
|
|
||||||
existingRule.actions = underride.actions;
|
|
||||||
} else {
|
|
||||||
// Add the rule
|
|
||||||
const ruleId = underride.rule_id;
|
|
||||||
logger.warn(`Adding default global underride for ${ruleId}`);
|
|
||||||
globalUnderrides.push(underride);
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
return newRules;
|
return newRules;
|
||||||
}
|
}
|
||||||
|
|||||||
Reference in New Issue
Block a user