diff --git a/changelog.d/12188.misc b/changelog.d/12188.misc
new file mode 100644
index 0000000000..403158481c
--- /dev/null
+++ b/changelog.d/12188.misc
@@ -0,0 +1 @@
+Add combined test for HTTP pusher and push rule. Contributed by Nick @ Beeper.
diff --git a/synapse/push/baserules.py b/synapse/push/baserules.py
index 832eaa34e9..f42f605f23 100644
--- a/synapse/push/baserules.py
+++ b/synapse/push/baserules.py
@@ -169,7 +169,7 @@ BASE_APPEND_OVERRIDE_RULES: List[Dict[str, Any]] = [
"kind": "event_match",
"key": "content.msgtype",
"pattern": "m.notice",
- "_id": "_suppress_notices",
+ "_cache_key": "_suppress_notices",
}
],
"actions": ["dont_notify"],
@@ -183,13 +183,13 @@ BASE_APPEND_OVERRIDE_RULES: List[Dict[str, Any]] = [
"kind": "event_match",
"key": "type",
"pattern": "m.room.member",
- "_id": "_member",
+ "_cache_key": "_member",
},
{
"kind": "event_match",
"key": "content.membership",
"pattern": "invite",
- "_id": "_invite_member",
+ "_cache_key": "_invite_member",
},
{"kind": "event_match", "key": "state_key", "pattern_type": "user_id"},
],
@@ -212,7 +212,7 @@ BASE_APPEND_OVERRIDE_RULES: List[Dict[str, Any]] = [
"kind": "event_match",
"key": "type",
"pattern": "m.room.member",
- "_id": "_member",
+ "_cache_key": "_member",
}
],
"actions": ["dont_notify"],
@@ -237,12 +237,12 @@ BASE_APPEND_OVERRIDE_RULES: List[Dict[str, Any]] = [
"kind": "event_match",
"key": "content.body",
"pattern": "@room",
- "_id": "_roomnotif_content",
+ "_cache_key": "_roomnotif_content",
},
{
"kind": "sender_notification_permission",
"key": "room",
- "_id": "_roomnotif_pl",
+ "_cache_key": "_roomnotif_pl",
},
],
"actions": ["notify", {"set_tweak": "highlight", "value": True}],
@@ -254,13 +254,13 @@ BASE_APPEND_OVERRIDE_RULES: List[Dict[str, Any]] = [
"kind": "event_match",
"key": "type",
"pattern": "m.room.tombstone",
- "_id": "_tombstone",
+ "_cache_key": "_tombstone",
},
{
"kind": "event_match",
"key": "state_key",
"pattern": "",
- "_id": "_tombstone_statekey",
+ "_cache_key": "_tombstone_statekey",
},
],
"actions": ["notify", {"set_tweak": "highlight", "value": True}],
@@ -272,7 +272,7 @@ BASE_APPEND_OVERRIDE_RULES: List[Dict[str, Any]] = [
"kind": "event_match",
"key": "type",
"pattern": "m.reaction",
- "_id": "_reaction",
+ "_cache_key": "_reaction",
}
],
"actions": ["dont_notify"],
@@ -288,7 +288,7 @@ BASE_APPEND_UNDERRIDE_RULES: List[Dict[str, Any]] = [
"kind": "event_match",
"key": "type",
"pattern": "m.call.invite",
- "_id": "_call",
+ "_cache_key": "_call",
}
],
"actions": [
@@ -302,12 +302,12 @@ BASE_APPEND_UNDERRIDE_RULES: List[Dict[str, Any]] = [
{
"rule_id": "global/underride/.m.rule.room_one_to_one",
"conditions": [
- {"kind": "room_member_count", "is": "2", "_id": "member_count"},
+ {"kind": "room_member_count", "is": "2", "_cache_key": "member_count"},
{
"kind": "event_match",
"key": "type",
"pattern": "m.room.message",
- "_id": "_message",
+ "_cache_key": "_message",
},
],
"actions": [
@@ -321,12 +321,12 @@ BASE_APPEND_UNDERRIDE_RULES: List[Dict[str, Any]] = [
{
"rule_id": "global/underride/.m.rule.encrypted_room_one_to_one",
"conditions": [
- {"kind": "room_member_count", "is": "2", "_id": "member_count"},
+ {"kind": "room_member_count", "is": "2", "_cache_key": "member_count"},
{
"kind": "event_match",
"key": "type",
"pattern": "m.room.encrypted",
- "_id": "_encrypted",
+ "_cache_key": "_encrypted",
},
],
"actions": [
@@ -342,7 +342,7 @@ BASE_APPEND_UNDERRIDE_RULES: List[Dict[str, Any]] = [
"kind": "event_match",
"key": "type",
"pattern": "m.room.message",
- "_id": "_message",
+ "_cache_key": "_message",
}
],
"actions": ["notify", {"set_tweak": "highlight", "value": False}],
@@ -356,7 +356,7 @@ BASE_APPEND_UNDERRIDE_RULES: List[Dict[str, Any]] = [
"kind": "event_match",
"key": "type",
"pattern": "m.room.encrypted",
- "_id": "_encrypted",
+ "_cache_key": "_encrypted",
}
],
"actions": ["notify", {"set_tweak": "highlight", "value": False}],
@@ -368,19 +368,19 @@ BASE_APPEND_UNDERRIDE_RULES: List[Dict[str, Any]] = [
"kind": "event_match",
"key": "type",
"pattern": "im.vector.modular.widgets",
- "_id": "_type_modular_widgets",
+ "_cache_key": "_type_modular_widgets",
},
{
"kind": "event_match",
"key": "content.type",
"pattern": "jitsi",
- "_id": "_content_type_jitsi",
+ "_cache_key": "_content_type_jitsi",
},
{
"kind": "event_match",
"key": "state_key",
"pattern": "*",
- "_id": "_is_state_event",
+ "_cache_key": "_is_state_event",
},
],
"actions": ["notify", {"set_tweak": "highlight", "value": False}],
diff --git a/synapse/push/bulk_push_rule_evaluator.py b/synapse/push/bulk_push_rule_evaluator.py
index fecf86034e..8140afcb6b 100644
--- a/synapse/push/bulk_push_rule_evaluator.py
+++ b/synapse/push/bulk_push_rule_evaluator.py
@@ -274,17 +274,17 @@ def _condition_checker(
cache: Dict[str, bool],
) -> bool:
for cond in conditions:
- _id = cond.get("_id", None)
- if _id:
- res = cache.get(_id, None)
+ _cache_key = cond.get("_cache_key", None)
+ if _cache_key:
+ res = cache.get(_cache_key, None)
if res is False:
return False
elif res is True:
continue
res = evaluator.matches(cond, uid, display_name)
- if _id:
- cache[_id] = bool(res)
+ if _cache_key:
+ cache[_cache_key] = bool(res)
if not res:
return False
diff --git a/synapse/push/clientformat.py b/synapse/push/clientformat.py
index c5708cd888..63b22d50ae 100644
--- a/synapse/push/clientformat.py
+++ b/synapse/push/clientformat.py
@@ -40,7 +40,7 @@ def format_push_rules_for_user(
# Remove internal stuff.
for c in r["conditions"]:
- c.pop("_id", None)
+ c.pop("_cache_key", None)
pattern_type = c.pop("pattern_type", None)
if pattern_type == "user_id":
diff --git a/tests/push/test_http.py b/tests/push/test_http.py
index c284beb37c..6691e07128 100644
--- a/tests/push/test_http.py
+++ b/tests/push/test_http.py
@@ -11,6 +11,7 @@
# 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.
+from typing import List, Tuple
from unittest.mock import Mock
from twisted.internet.defer import Deferred
@@ -18,7 +19,7 @@ from twisted.internet.defer import Deferred
import synapse.rest.admin
from synapse.logging.context import make_deferred_yieldable
from synapse.push import PusherConfigException
-from synapse.rest.client import login, receipts, room
+from synapse.rest.client import login, push_rule, receipts, room
from tests.unittest import HomeserverTestCase, override_config
@@ -29,6 +30,7 @@ class HTTPPusherTests(HomeserverTestCase):
room.register_servlets,
login.register_servlets,
receipts.register_servlets,
+ push_rule.register_servlets,
]
user_id = True
hijack_auth = False
@@ -39,12 +41,12 @@ class HTTPPusherTests(HomeserverTestCase):
return config
def make_homeserver(self, reactor, clock):
- self.push_attempts = []
+ self.push_attempts: List[tuple[Deferred, str, dict]] = []
m = Mock()
def post_json_get_json(url, body):
- d = Deferred()
+ d: Deferred = Deferred()
self.push_attempts.append((d, url, body))
return make_deferred_yieldable(d)
@@ -719,3 +721,67 @@ class HTTPPusherTests(HomeserverTestCase):
access_token=access_token,
)
self.assertEqual(channel.code, 200, channel.json_body)
+
+ def _make_user_with_pusher(self, username: str) -> Tuple[str, str]:
+ user_id = self.register_user(username, "pass")
+ access_token = self.login(username, "pass")
+
+ # Register the pusher
+ user_tuple = self.get_success(
+ self.hs.get_datastores().main.get_user_by_access_token(access_token)
+ )
+ token_id = user_tuple.token_id
+
+ self.get_success(
+ self.hs.get_pusherpool().add_pusher(
+ user_id=user_id,
+ access_token=token_id,
+ kind="http",
+ app_id="m.http",
+ app_display_name="HTTP Push Notifications",
+ device_display_name="pushy push",
+ pushkey="a@example.com",
+ lang=None,
+ data={"url": "http://example.com/_matrix/push/v1/notify"},
+ )
+ )
+
+ return user_id, access_token
+
+ def test_dont_notify_rule_overrides_message(self):
+ """
+ The override push rule will suppress notification
+ """
+
+ user_id, access_token = self._make_user_with_pusher("user")
+ other_user_id, other_access_token = self._make_user_with_pusher("otheruser")
+
+ # Create a room
+ room = self.helper.create_room_as(user_id, tok=access_token)
+
+ # Disable user notifications for this room -> user
+ body = {
+ "conditions": [{"kind": "event_match", "key": "room_id", "pattern": room}],
+ "actions": ["dont_notify"],
+ }
+ channel = self.make_request(
+ "PUT",
+ "/pushrules/global/override/best.friend",
+ body,
+ access_token=access_token,
+ )
+ self.assertEqual(channel.code, 200)
+
+ # Check we start with no pushes
+ self.assertEqual(len(self.push_attempts), 0)
+
+ # The other user joins
+ self.helper.join(room=room, user=other_user_id, tok=other_access_token)
+
+ # The other user sends a message (ignored by dont_notify push rule set above)
+ self.helper.send(room, body="Hi!", tok=other_access_token)
+ self.assertEqual(len(self.push_attempts), 0)
+
+ # The user sends a message back (sends a notification)
+ self.helper.send(room, body="Hello", tok=access_token)
+ self.assertEqual(len(self.push_attempts), 1)
|
