mirror of
https://github.com/matrix-org/matrix-js-sdk.git
synced 2025-06-10 02:21:19 +03:00
1e92c13a75
* Improve PushProcessor::getPushRuleGlobRegex Fix cache key not taking non-pattern parameters into account Use lookarounds to ensure the word boundary isn't treated as part of the match Signed-off-by: Michael Telatynski <7t3chguy@gmail.com> * Add tests Signed-off-by: Michael Telatynski <7t3chguy@gmail.com> --------- Signed-off-by: Michael Telatynski <7t3chguy@gmail.com>
1045 lines
39 KiB
TypeScript
1045 lines
39 KiB
TypeScript
/*
|
|
Copyright 2025 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 * as utils from "../test-utils/test-utils";
|
|
import { type IActionsObject, PushProcessor } from "../../src/pushprocessor";
|
|
import {
|
|
ConditionKind,
|
|
EventType,
|
|
type IContent,
|
|
type IPushRule,
|
|
type MatrixClient,
|
|
type MatrixEvent,
|
|
PushRuleActionName,
|
|
RuleId,
|
|
TweakName,
|
|
} from "../../src";
|
|
import { mockClientMethodsUser } from "../test-utils/client";
|
|
|
|
const msc3914RoomCallRule: IPushRule = {
|
|
rule_id: ".org.matrix.msc3914.rule.room.call",
|
|
default: true,
|
|
enabled: true,
|
|
conditions: [
|
|
{
|
|
kind: ConditionKind.EventMatch,
|
|
key: "type",
|
|
pattern: "org.matrix.msc3401.call",
|
|
},
|
|
{
|
|
kind: ConditionKind.CallStarted,
|
|
},
|
|
],
|
|
actions: [PushRuleActionName.Notify, { set_tweak: TweakName.Sound, value: "default" }],
|
|
};
|
|
|
|
describe("NotificationService", function () {
|
|
const testUserId = "@ali:matrix.org";
|
|
const testDisplayName = "Alice M";
|
|
const testRoomId = "!fl1bb13:localhost";
|
|
|
|
let testEvent: MatrixEvent;
|
|
|
|
let pushProcessor: PushProcessor;
|
|
|
|
let matrixClient: MatrixClient;
|
|
|
|
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({
|
|
type: "m.room.message",
|
|
room: testRoomId,
|
|
user: "@alfred:localhost",
|
|
event: true,
|
|
content: {
|
|
body: "",
|
|
msgtype: "m.text",
|
|
},
|
|
});
|
|
matrixClient.pushRules = PushProcessor.rewriteDefaultRules(matrixClient.pushRules!);
|
|
pushProcessor = new PushProcessor(matrixClient);
|
|
});
|
|
|
|
// User IDs
|
|
|
|
it("should bing on a user ID.", function () {
|
|
testEvent.event.content!.body = "Hello @ali:matrix.org, how are you?";
|
|
const actions = pushProcessor.actionsForEvent(testEvent);
|
|
expect(actions.tweaks.highlight).toEqual(true);
|
|
});
|
|
|
|
it("should bing on a partial user ID with an @.", function () {
|
|
testEvent.event.content!.body = "Hello @ali, how are you?";
|
|
const actions = pushProcessor.actionsForEvent(testEvent);
|
|
expect(actions.tweaks.highlight).toEqual(true);
|
|
});
|
|
|
|
it("should bing on a partial user ID without @.", function () {
|
|
testEvent.event.content!.body = "Hello ali, how are you?";
|
|
const actions = pushProcessor.actionsForEvent(testEvent);
|
|
expect(actions.tweaks.highlight).toEqual(true);
|
|
});
|
|
|
|
it("should bing on a case-insensitive user ID.", function () {
|
|
testEvent.event.content!.body = "Hello @AlI:matrix.org, how are you?";
|
|
const actions = pushProcessor.actionsForEvent(testEvent);
|
|
expect(actions.tweaks.highlight).toEqual(true);
|
|
});
|
|
|
|
// Display names
|
|
|
|
it("should bing on a display name.", function () {
|
|
testEvent.event.content!.body = "Hello Alice M, how are you?";
|
|
const actions = pushProcessor.actionsForEvent(testEvent);
|
|
expect(actions.tweaks.highlight).toEqual(true);
|
|
});
|
|
|
|
it("should bing on a case-insensitive display name.", function () {
|
|
testEvent.event.content!.body = "Hello ALICE M, how are you?";
|
|
const actions = pushProcessor.actionsForEvent(testEvent);
|
|
expect(actions.tweaks.highlight).toEqual(true);
|
|
});
|
|
|
|
// Bing words
|
|
|
|
it("should bing on a bing word.", function () {
|
|
testEvent.event.content!.body = "I really like coffee";
|
|
const actions = pushProcessor.actionsForEvent(testEvent);
|
|
expect(actions.tweaks.highlight).toEqual(true);
|
|
});
|
|
|
|
it("should bing on case-insensitive bing words.", function () {
|
|
testEvent.event.content!.body = "Coffee is great";
|
|
const actions = pushProcessor.actionsForEvent(testEvent);
|
|
expect(actions.tweaks.highlight).toEqual(true);
|
|
});
|
|
|
|
it("should bing on wildcard (.*) bing words.", function () {
|
|
testEvent.event.content!.body = "It was foomahbar I think.";
|
|
const actions = pushProcessor.actionsForEvent(testEvent);
|
|
expect(actions.tweaks.highlight).toEqual(true);
|
|
});
|
|
|
|
it("should not bing on room server ACL changes", function () {
|
|
testEvent = utils.mkEvent({
|
|
type: EventType.RoomServerAcl,
|
|
room: testRoomId,
|
|
user: "@alfred:localhost",
|
|
skey: "",
|
|
event: true,
|
|
content: {},
|
|
});
|
|
|
|
const actions = pushProcessor.actionsForEvent(testEvent);
|
|
expect(actions.tweaks.highlight).toBeFalsy();
|
|
expect(actions.tweaks.sound).toBeFalsy();
|
|
expect(actions.notify).toBeFalsy();
|
|
});
|
|
|
|
// invalid
|
|
|
|
it("should gracefully handle bad input.", function () {
|
|
// The following body is an object (not a string) and thus is invalid
|
|
// for matching against.
|
|
testEvent.event.content!.body = { foo: "bar" };
|
|
const actions = pushProcessor.actionsForEvent(testEvent);
|
|
expect(actions.tweaks.highlight).toEqual(false);
|
|
});
|
|
|
|
it("a rule with no conditions matches every event.", function () {
|
|
expect(
|
|
pushProcessor.ruleMatchesEvent(
|
|
{
|
|
rule_id: "rule1",
|
|
actions: [],
|
|
conditions: [],
|
|
default: false,
|
|
enabled: true,
|
|
},
|
|
testEvent,
|
|
),
|
|
).toBe(true);
|
|
expect(
|
|
pushProcessor.ruleMatchesEvent(
|
|
{
|
|
rule_id: "rule1",
|
|
actions: [],
|
|
default: false,
|
|
enabled: true,
|
|
},
|
|
testEvent,
|
|
),
|
|
).toBe(true);
|
|
});
|
|
|
|
describe("group call started push rule", () => {
|
|
beforeEach(() => {
|
|
matrixClient.pushRules!.global!.underride!.find((r) => r.rule_id === ".m.rule.fallback")!.enabled = false;
|
|
});
|
|
|
|
const getActionsForEvent = (prevContent: IContent, content: IContent): IActionsObject => {
|
|
testEvent = utils.mkEvent({
|
|
type: "org.matrix.msc3401.call",
|
|
room: testRoomId,
|
|
user: "@alice:foo",
|
|
skey: "state_key",
|
|
event: true,
|
|
content: content,
|
|
prev_content: prevContent,
|
|
});
|
|
|
|
return pushProcessor.actionsForEvent(testEvent);
|
|
};
|
|
|
|
const assertDoesNotify = (actions: IActionsObject): void => {
|
|
expect(actions?.notify).toBeTruthy();
|
|
expect(actions?.tweaks?.sound).toBeTruthy();
|
|
expect(actions?.tweaks?.highlight).toBeFalsy();
|
|
};
|
|
|
|
const assertDoesNotNotify = (actions: IActionsObject): void => {
|
|
expect(actions?.notify).toBeFalsy();
|
|
expect(actions?.tweaks?.sound).toBeFalsy();
|
|
expect(actions?.tweaks?.highlight).toBeFalsy();
|
|
};
|
|
|
|
it.each(["m.ring", "m.prompt"])(
|
|
"should notify when new group call event appears with %s intent",
|
|
(intent: string) => {
|
|
assertDoesNotify(
|
|
getActionsForEvent(
|
|
{},
|
|
{
|
|
"m.intent": intent,
|
|
"m.type": "m.voice",
|
|
"m.name": "Call",
|
|
},
|
|
),
|
|
);
|
|
},
|
|
);
|
|
|
|
it("should notify when a call is un-terminated", () => {
|
|
assertDoesNotify(
|
|
getActionsForEvent(
|
|
{
|
|
"m.intent": "m.ring",
|
|
"m.type": "m.voice",
|
|
"m.name": "Call",
|
|
"m.terminated": "All users left",
|
|
},
|
|
{
|
|
"m.intent": "m.ring",
|
|
"m.type": "m.voice",
|
|
"m.name": "Call",
|
|
},
|
|
),
|
|
);
|
|
});
|
|
|
|
it("should not notify when call is terminated", () => {
|
|
assertDoesNotNotify(
|
|
getActionsForEvent(
|
|
{
|
|
"m.intent": "m.ring",
|
|
"m.type": "m.voice",
|
|
"m.name": "Call",
|
|
},
|
|
{
|
|
"m.intent": "m.ring",
|
|
"m.type": "m.voice",
|
|
"m.name": "Call",
|
|
"m.terminated": "All users left",
|
|
},
|
|
),
|
|
);
|
|
});
|
|
|
|
it("should ignore with m.room intent", () => {
|
|
assertDoesNotNotify(
|
|
getActionsForEvent(
|
|
{},
|
|
{
|
|
"m.intent": "m.room",
|
|
"m.type": "m.voice",
|
|
"m.name": "Call",
|
|
},
|
|
),
|
|
);
|
|
});
|
|
|
|
describe("ignoring non-relevant state changes", () => {
|
|
it("should ignore intent changes", () => {
|
|
assertDoesNotNotify(
|
|
getActionsForEvent(
|
|
{
|
|
"m.intent": "m.ring",
|
|
"m.type": "m.voice",
|
|
"m.name": "Call",
|
|
},
|
|
{
|
|
"m.intent": "m.ring",
|
|
"m.type": "m.video",
|
|
"m.name": "Call",
|
|
},
|
|
),
|
|
);
|
|
});
|
|
|
|
it("should ignore name changes", () => {
|
|
assertDoesNotNotify(
|
|
getActionsForEvent(
|
|
{
|
|
"m.intent": "m.ring",
|
|
"m.type": "m.voice",
|
|
"m.name": "Call",
|
|
},
|
|
{
|
|
"m.intent": "m.ring",
|
|
"m.type": "m.voice",
|
|
"m.name": "New call",
|
|
},
|
|
),
|
|
);
|
|
});
|
|
});
|
|
});
|
|
|
|
describe("Test exact event matching", () => {
|
|
it.each([
|
|
// Simple string matching.
|
|
{ value: "bar", eventValue: "bar", expected: true },
|
|
// Matches are case-sensitive.
|
|
{ value: "bar", eventValue: "BAR", expected: false },
|
|
// Matches must match the full string.
|
|
{ value: "bar", eventValue: "barbar", expected: false },
|
|
// Values should not be type-coerced.
|
|
{ value: "bar", eventValue: true, expected: false },
|
|
{ value: "bar", eventValue: 1, expected: false },
|
|
{ value: "bar", eventValue: false, expected: false },
|
|
// Boolean matching.
|
|
{ value: true, eventValue: true, expected: true },
|
|
{ value: false, eventValue: false, expected: true },
|
|
// Types should not be coerced.
|
|
{ value: true, eventValue: "true", expected: false },
|
|
{ value: true, eventValue: 1, expected: false },
|
|
{ value: false, eventValue: null, expected: false },
|
|
// Null matching.
|
|
{ value: null, eventValue: null, expected: true },
|
|
// Types should not be coerced
|
|
{ value: null, eventValue: false, expected: false },
|
|
{ value: null, eventValue: 0, expected: false },
|
|
{ value: null, eventValue: "", expected: false },
|
|
{ value: null, eventValue: undefined, expected: false },
|
|
// Compound values should never be matched.
|
|
{ value: "bar", eventValue: ["bar"], expected: false },
|
|
{ value: "bar", eventValue: { bar: true }, expected: false },
|
|
{ value: true, eventValue: [true], expected: false },
|
|
{ value: true, eventValue: { true: true }, expected: false },
|
|
{ value: null, eventValue: [], expected: false },
|
|
{ value: null, eventValue: {}, expected: false },
|
|
])("test $value against $eventValue", ({ value, eventValue, expected }) => {
|
|
matrixClient.pushRules! = {
|
|
global: {
|
|
override: [
|
|
{
|
|
actions: [PushRuleActionName.Notify],
|
|
conditions: [
|
|
{
|
|
kind: ConditionKind.EventPropertyIs,
|
|
key: "content.foo",
|
|
value: value,
|
|
},
|
|
],
|
|
default: true,
|
|
enabled: true,
|
|
rule_id: ".m.rule.test",
|
|
},
|
|
],
|
|
},
|
|
};
|
|
|
|
testEvent = utils.mkEvent({
|
|
type: "m.room.message",
|
|
room: testRoomId,
|
|
user: "@alfred:localhost",
|
|
event: true,
|
|
content: {
|
|
foo: eventValue,
|
|
},
|
|
});
|
|
|
|
const actions = pushProcessor.actionsForEvent(testEvent);
|
|
expect(!!actions?.notify).toBe(expected);
|
|
});
|
|
});
|
|
|
|
describe("Test event property contains", () => {
|
|
it.each([
|
|
// Simple string matching.
|
|
{ value: "bar", eventValue: ["bar"], expected: true },
|
|
// Matches are case-sensitive.
|
|
{ value: "bar", eventValue: ["BAR"], expected: false },
|
|
// Values should not be type-coerced.
|
|
{ value: "bar", eventValue: [true], expected: false },
|
|
{ value: "bar", eventValue: [1], expected: false },
|
|
{ value: "bar", eventValue: [false], expected: false },
|
|
// Boolean matching.
|
|
{ value: true, eventValue: [true], expected: true },
|
|
{ value: false, eventValue: [false], expected: true },
|
|
// Types should not be coerced.
|
|
{ value: true, eventValue: ["true"], expected: false },
|
|
{ value: true, eventValue: [1], expected: false },
|
|
{ value: false, eventValue: [null], expected: false },
|
|
// Null matching.
|
|
{ value: null, eventValue: [null], expected: true },
|
|
// Types should not be coerced
|
|
{ value: null, eventValue: [false], expected: false },
|
|
{ value: null, eventValue: [0], expected: false },
|
|
{ value: null, eventValue: [""], expected: false },
|
|
{ value: null, eventValue: [undefined], expected: false },
|
|
// Non-array or empty values should never be matched.
|
|
{ value: "bar", eventValue: "bar", expected: false },
|
|
{ value: "bar", eventValue: { bar: true }, expected: false },
|
|
{ value: true, eventValue: { true: true }, expected: false },
|
|
{ value: true, eventValue: true, expected: false },
|
|
{ value: null, eventValue: [], expected: false },
|
|
{ value: null, eventValue: {}, expected: false },
|
|
{ value: null, eventValue: null, expected: false },
|
|
{ value: null, eventValue: undefined, expected: false },
|
|
])("test $value against $eventValue", ({ value, eventValue, expected }) => {
|
|
matrixClient.pushRules! = {
|
|
global: {
|
|
override: [
|
|
{
|
|
actions: [PushRuleActionName.Notify],
|
|
conditions: [
|
|
{
|
|
kind: ConditionKind.EventPropertyContains,
|
|
key: "content.foo",
|
|
value: value,
|
|
},
|
|
],
|
|
default: true,
|
|
enabled: true,
|
|
rule_id: ".m.rule.test",
|
|
},
|
|
],
|
|
},
|
|
};
|
|
|
|
testEvent = utils.mkEvent({
|
|
type: "m.room.message",
|
|
room: testRoomId,
|
|
user: "@alfred:localhost",
|
|
event: true,
|
|
content: {
|
|
foo: eventValue,
|
|
},
|
|
});
|
|
|
|
const actions = pushProcessor.actionsForEvent(testEvent);
|
|
expect(actions?.notify).toBe(expected ? true : undefined);
|
|
});
|
|
});
|
|
|
|
it.each([
|
|
// The properly escaped key works.
|
|
{ key: "content.m\\.test.foo", pattern: "bar", expected: true },
|
|
// An unescaped version does not match.
|
|
{ key: "content.m.test.foo", pattern: "bar", expected: false },
|
|
// Over escaping does not match.
|
|
{ key: "content.m\\.test\\.foo", pattern: "bar", expected: false },
|
|
// Escaping backslashes should match.
|
|
{ key: "content.m\\\\example", pattern: "baz", expected: true },
|
|
// An unnecessary escape sequence leaves the backslash and still matches.
|
|
{ key: "content.m\\example", pattern: "baz", expected: true },
|
|
])("test against escaped dotted paths '$key'", ({ key, pattern, expected }) => {
|
|
testEvent = utils.mkEvent({
|
|
type: "m.room.message",
|
|
room: testRoomId,
|
|
user: "@alfred:localhost",
|
|
event: true,
|
|
content: {
|
|
// A dot in the field name.
|
|
"m.test": { foo: "bar" },
|
|
// A backslash in a field name.
|
|
"m\\example": "baz",
|
|
},
|
|
});
|
|
|
|
expect(
|
|
pushProcessor.ruleMatchesEvent(
|
|
{
|
|
rule_id: "rule1",
|
|
actions: [],
|
|
conditions: [
|
|
{
|
|
kind: ConditionKind.EventMatch,
|
|
key: key,
|
|
pattern: pattern,
|
|
},
|
|
],
|
|
default: false,
|
|
enabled: true,
|
|
},
|
|
testEvent,
|
|
),
|
|
).toBe(expected);
|
|
});
|
|
|
|
describe("getPushRuleById()", () => {
|
|
it("returns null when rule id is not in rule set", () => {
|
|
expect(pushProcessor.getPushRuleById("non-existant-rule")).toBeNull();
|
|
});
|
|
|
|
it("returns push rule when it is found in rule set", () => {
|
|
expect(pushProcessor.getPushRuleById(".org.matrix.msc3914.rule.room.call")).toEqual(msc3914RoomCallRule);
|
|
});
|
|
});
|
|
|
|
describe("getPushRuleAndKindById()", () => {
|
|
it("returns null when rule id is not in rule set", () => {
|
|
expect(pushProcessor.getPushRuleAndKindById("non-existant-rule")).toBeNull();
|
|
});
|
|
|
|
it("returns push rule when it is found in rule set", () => {
|
|
expect(pushProcessor.getPushRuleAndKindById(".org.matrix.msc3914.rule.room.call")).toEqual({
|
|
kind: "underride",
|
|
rule: msc3914RoomCallRule,
|
|
});
|
|
});
|
|
});
|
|
|
|
describe("test intentional mentions behaviour", () => {
|
|
it.each([RuleId.ContainsUserName, RuleId.ContainsDisplayName, RuleId.AtRoomNotification])(
|
|
"Rule %s matches unless intentional mentions are enabled",
|
|
(ruleId) => {
|
|
const rule = {
|
|
rule_id: ruleId,
|
|
actions: [],
|
|
conditions: [],
|
|
default: false,
|
|
enabled: true,
|
|
};
|
|
expect(pushProcessor.ruleMatchesEvent(rule, testEvent)).toBe(true);
|
|
|
|
// Add the mentions property to the event and the rule is now disabled.
|
|
testEvent = utils.mkEvent({
|
|
type: "m.room.message",
|
|
room: testRoomId,
|
|
user: "@alfred:localhost",
|
|
event: true,
|
|
content: {
|
|
"body": "",
|
|
"msgtype": "m.text",
|
|
"m.mentions": {},
|
|
},
|
|
});
|
|
|
|
expect(pushProcessor.ruleMatchesEvent(rule, testEvent)).toBe(false);
|
|
},
|
|
);
|
|
});
|
|
});
|
|
|
|
describe("Test PushProcessor.partsForDottedKey", function () {
|
|
it.each([
|
|
// A field with no dots.
|
|
["m", ["m"]],
|
|
// Simple dotted fields.
|
|
["m.foo", ["m", "foo"]],
|
|
["m.foo.bar", ["m", "foo", "bar"]],
|
|
// Backslash is used as an escape character.
|
|
["m\\.foo", ["m.foo"]],
|
|
["m\\\\.foo", ["m\\", "foo"]],
|
|
["m\\\\\\.foo", ["m\\.foo"]],
|
|
["m\\\\\\\\.foo", ["m\\\\", "foo"]],
|
|
["m\\foo", ["m\\foo"]],
|
|
["m\\\\foo", ["m\\foo"]],
|
|
["m\\\\\\foo", ["m\\\\foo"]],
|
|
["m\\\\\\\\foo", ["m\\\\foo"]],
|
|
// Ensure that escapes at the end don't cause issues.
|
|
["m.foo\\", ["m", "foo\\"]],
|
|
["m.foo\\\\", ["m", "foo\\"]],
|
|
["m.foo\\.", ["m", "foo."]],
|
|
["m.foo\\\\.", ["m", "foo\\", ""]],
|
|
["m.foo\\\\\\.", ["m", "foo\\."]],
|
|
// Empty parts (corresponding to properties which are an empty string) are allowed.
|
|
[".m", ["", "m"]],
|
|
["..m", ["", "", "m"]],
|
|
["m.", ["m", ""]],
|
|
["m..", ["m", "", ""]],
|
|
["m..foo", ["m", "", "foo"]],
|
|
])("partsFotDottedKey for %s", (path: string, expected: string[]) => {
|
|
expect(PushProcessor.partsForDottedKey(path)).toStrictEqual(expected);
|
|
});
|
|
});
|
|
|
|
describe("rewriteDefaultRules", () => {
|
|
it("should add default rules in the correct order", () => {
|
|
const pushRules = PushProcessor.rewriteDefaultRules({
|
|
device: {},
|
|
global: {
|
|
content: [],
|
|
override: [
|
|
// Include user-defined push rules inbetween .m.rule.master and other default rules to assert they are maintained in-order.
|
|
{
|
|
rule_id: ".m.rule.master",
|
|
default: true,
|
|
enabled: false,
|
|
conditions: [],
|
|
actions: [],
|
|
},
|
|
{
|
|
actions: [
|
|
PushRuleActionName.Notify,
|
|
{
|
|
set_tweak: TweakName.Sound,
|
|
value: "default",
|
|
},
|
|
{
|
|
set_tweak: TweakName.Highlight,
|
|
},
|
|
],
|
|
enabled: true,
|
|
pattern: "coffee",
|
|
rule_id: "coffee",
|
|
default: false,
|
|
},
|
|
{
|
|
actions: [
|
|
PushRuleActionName.Notify,
|
|
{
|
|
set_tweak: TweakName.Sound,
|
|
value: "default",
|
|
},
|
|
{
|
|
set_tweak: TweakName.Highlight,
|
|
},
|
|
],
|
|
conditions: [
|
|
{
|
|
kind: ConditionKind.ContainsDisplayName,
|
|
},
|
|
],
|
|
enabled: true,
|
|
default: true,
|
|
rule_id: ".m.rule.contains_display_name",
|
|
},
|
|
{
|
|
actions: [
|
|
PushRuleActionName.Notify,
|
|
{
|
|
set_tweak: TweakName.Sound,
|
|
value: "default",
|
|
},
|
|
],
|
|
conditions: [
|
|
{
|
|
is: "2",
|
|
kind: ConditionKind.RoomMemberCount,
|
|
},
|
|
],
|
|
enabled: true,
|
|
rule_id: ".m.rule.room_one_to_one",
|
|
default: true,
|
|
},
|
|
],
|
|
room: [],
|
|
sender: [],
|
|
underride: [
|
|
{
|
|
actions: [
|
|
PushRuleActionName.Notify,
|
|
{
|
|
set_tweak: TweakName.Highlight,
|
|
value: false,
|
|
},
|
|
],
|
|
conditions: [],
|
|
enabled: true,
|
|
rule_id: "user-defined",
|
|
default: false,
|
|
},
|
|
msc3914RoomCallRule,
|
|
{
|
|
actions: [
|
|
PushRuleActionName.Notify,
|
|
{
|
|
set_tweak: TweakName.Highlight,
|
|
value: false,
|
|
},
|
|
],
|
|
conditions: [],
|
|
enabled: true,
|
|
rule_id: ".m.rule.fallback",
|
|
default: true,
|
|
},
|
|
],
|
|
},
|
|
});
|
|
|
|
// 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 = pushRules.global.override?.findIndex(
|
|
(rule) => rule.rule_id === RuleId.ContainsDisplayName,
|
|
);
|
|
expect(containsDisplayNameRuleIdx).toBeGreaterThan(-1);
|
|
const isRoomMentionRuleIdx = pushRules.global.override?.findIndex(
|
|
(rule) => rule.rule_id === RuleId.IsRoomMention,
|
|
);
|
|
expect(isRoomMentionRuleIdx).toBeGreaterThan(-1);
|
|
const mReactionRuleIdx = pushRules.global.override?.findIndex((rule) => rule.rule_id === ".m.rule.reaction");
|
|
expect(mReactionRuleIdx).toBeGreaterThan(-1);
|
|
|
|
expect(containsDisplayNameRuleIdx).toBeLessThan(isRoomMentionRuleIdx!);
|
|
expect(isRoomMentionRuleIdx).toBeLessThan(mReactionRuleIdx!);
|
|
|
|
expect(pushRules.global.override?.map((r) => r.rule_id)).toEqual([
|
|
".m.rule.master",
|
|
"coffee",
|
|
".m.rule.contains_display_name",
|
|
".m.rule.room_one_to_one",
|
|
".m.rule.is_room_mention",
|
|
".m.rule.reaction",
|
|
".org.matrix.msc3786.rule.room.server_acl",
|
|
]);
|
|
expect(pushRules.global.underride?.map((r) => r.rule_id)).toEqual([
|
|
"user-defined",
|
|
".org.matrix.msc3914.rule.room.call",
|
|
// Assert that unknown default rules are maintained
|
|
".m.rule.fallback",
|
|
]);
|
|
});
|
|
|
|
it("should add missing msc3914 rule in correct place", () => {
|
|
const pushRules = PushProcessor.rewriteDefaultRules({
|
|
device: {},
|
|
global: {
|
|
// Sample push rules from a Synapse user.
|
|
// Note that rules 2 and 3 are backwards, this will trigger a warning in the console.
|
|
underride: [
|
|
{
|
|
conditions: [
|
|
{
|
|
kind: "event_match",
|
|
key: "type",
|
|
pattern: "m.call.invite",
|
|
},
|
|
],
|
|
actions: [
|
|
"notify",
|
|
{
|
|
set_tweak: "sound",
|
|
value: "ring",
|
|
},
|
|
{
|
|
set_tweak: "highlight",
|
|
value: false,
|
|
},
|
|
],
|
|
rule_id: ".m.rule.call",
|
|
default: true,
|
|
enabled: true,
|
|
},
|
|
{
|
|
conditions: [
|
|
{
|
|
kind: "event_match",
|
|
key: "type",
|
|
pattern: "m.room.message",
|
|
},
|
|
{
|
|
kind: "room_member_count",
|
|
is: "2",
|
|
},
|
|
],
|
|
actions: [
|
|
"notify",
|
|
{
|
|
set_tweak: "sound",
|
|
value: "TEST1",
|
|
},
|
|
{
|
|
set_tweak: "highlight",
|
|
value: false,
|
|
},
|
|
],
|
|
rule_id: ".m.rule.room_one_to_one",
|
|
default: true,
|
|
enabled: true,
|
|
},
|
|
{
|
|
conditions: [
|
|
{
|
|
kind: "event_match",
|
|
key: "type",
|
|
pattern: "m.room.encrypted",
|
|
},
|
|
{
|
|
kind: "room_member_count",
|
|
is: "2",
|
|
},
|
|
],
|
|
actions: [
|
|
"notify",
|
|
{
|
|
set_tweak: "sound",
|
|
value: "TEST2",
|
|
},
|
|
{
|
|
set_tweak: "highlight",
|
|
value: false,
|
|
},
|
|
],
|
|
rule_id: ".m.rule.encrypted_room_one_to_one",
|
|
default: true,
|
|
enabled: true,
|
|
},
|
|
{
|
|
conditions: [
|
|
{
|
|
kind: "event_match",
|
|
key: "type",
|
|
pattern: "m.room.message",
|
|
},
|
|
],
|
|
actions: ["dont_notify"],
|
|
rule_id: ".m.rule.message",
|
|
default: true,
|
|
enabled: true,
|
|
},
|
|
{
|
|
conditions: [
|
|
{
|
|
kind: "event_match",
|
|
key: "type",
|
|
pattern: "m.room.encrypted",
|
|
},
|
|
],
|
|
actions: ["dont_notify"],
|
|
rule_id: ".m.rule.encrypted",
|
|
default: true,
|
|
enabled: true,
|
|
},
|
|
{
|
|
conditions: [
|
|
{
|
|
kind: "event_match",
|
|
key: "type",
|
|
pattern: "im.vector.modular.widgets",
|
|
},
|
|
{
|
|
kind: "event_match",
|
|
key: "content.type",
|
|
pattern: "jitsi",
|
|
},
|
|
{
|
|
kind: "event_match",
|
|
key: "state_key",
|
|
pattern: "*",
|
|
},
|
|
],
|
|
actions: [
|
|
"notify",
|
|
{
|
|
set_tweak: "highlight",
|
|
value: false,
|
|
},
|
|
],
|
|
rule_id: ".im.vector.jitsi",
|
|
default: true,
|
|
enabled: true,
|
|
},
|
|
] as IPushRule[],
|
|
},
|
|
});
|
|
|
|
expect(pushRules.global.underride?.map((r) => r.rule_id)).toEqual([
|
|
".m.rule.call",
|
|
".org.matrix.msc3914.rule.room.call",
|
|
".m.rule.room_one_to_one",
|
|
".m.rule.encrypted_room_one_to_one",
|
|
".m.rule.message",
|
|
".m.rule.encrypted",
|
|
".im.vector.jitsi",
|
|
]);
|
|
});
|
|
});
|
|
|
|
describe("getPushRuleGlobRegex", () => {
|
|
it("should not confuse flags in cache", () => {
|
|
const pattern = "Test";
|
|
const regex1 = PushProcessor.getPushRuleGlobRegex(pattern, false, "i");
|
|
const regex2 = PushProcessor.getPushRuleGlobRegex(pattern, false, "g");
|
|
const regex3 = PushProcessor.getPushRuleGlobRegex(pattern, false, "i");
|
|
|
|
expect(regex1.flags).toBe("i");
|
|
expect(regex2.flags).toBe("g");
|
|
|
|
expect(regex1).not.toEqual(regex2);
|
|
expect(regex1).toEqual(regex3);
|
|
});
|
|
|
|
it("should not include word boundary in match", () => {
|
|
const pattern = "@room";
|
|
const regex = PushProcessor.getPushRuleGlobRegex(pattern, true);
|
|
const input = "Foo @room Bar";
|
|
expect(input.split(regex)).toEqual(["Foo ", "@room", " Bar"]);
|
|
});
|
|
});
|