diff --git a/changelog.d/6301.feature b/changelog.d/6301.feature
index b7ff3fad3b..78a187a1dc 100644
--- a/changelog.d/6301.feature
+++ b/changelog.d/6301.feature
@@ -1 +1 @@
-Implement label-based filtering.
+Implement label-based filtering on `/sync` and `/messages` ([MSC2326](https://github.com/matrix-org/matrix-doc/pull/2326)).
diff --git a/synapse/api/constants.py b/synapse/api/constants.py
index 999ec02fd9..cf4ce5f5a2 100644
--- a/synapse/api/constants.py
+++ b/synapse/api/constants.py
@@ -140,4 +140,7 @@ class LimitBlockingTypes(object):
HS_DISABLED = "hs_disabled"
-LabelsField = "org.matrix.labels"
+class EventContentFields(object):
+ """Fields found in events' content, regardless of type."""
+ # Labels for the event, cf https://github.com/matrix-org/matrix-doc/pull/2326
+ Labels = "org.matrix.labels"
diff --git a/synapse/api/filtering.py b/synapse/api/filtering.py
index bd91b9f018..30a7ee0a7a 100644
--- a/synapse/api/filtering.py
+++ b/synapse/api/filtering.py
@@ -20,7 +20,7 @@ from jsonschema import FormatChecker
from twisted.internet import defer
-from synapse.api.constants import LabelsField
+from synapse.api.constants import EventContentFields
from synapse.api.errors import SynapseError
from synapse.storage.presence import UserPresenceState
from synapse.types import RoomID, UserID
@@ -67,6 +67,8 @@ ROOM_EVENT_FILTER_SCHEMA = {
"contains_url": {"type": "boolean"},
"lazy_load_members": {"type": "boolean"},
"include_redundant_members": {"type": "boolean"},
+ # Include or exclude events with the provided labels.
+ # cf https://github.com/matrix-org/matrix-doc/pull/2326
"org.matrix.labels": {"type": "array", "items": {"type": "string"}},
"org.matrix.not_labels": {"type": "array", "items": {"type": "string"}},
},
@@ -307,7 +309,7 @@ class Filter(object):
content = event.get("content", {})
# check if there is a string url field in the content for filtering purposes
contains_url = isinstance(content.get("url"), text_type)
- labels = content.get(LabelsField, [])
+ labels = content.get(EventContentFields.Labels, [])
return self.check_fields(room_id, sender, ev_type, labels, contains_url)
diff --git a/synapse/storage/data_stores/main/events.py b/synapse/storage/data_stores/main/events.py
index 2b900f1ce1..42ffa9066a 100644
--- a/synapse/storage/data_stores/main/events.py
+++ b/synapse/storage/data_stores/main/events.py
@@ -29,7 +29,7 @@ from prometheus_client import Counter, Histogram
from twisted.internet import defer
import synapse.metrics
-from synapse.api.constants import EventTypes, LabelsField
+from synapse.api.constants import EventTypes, EventContentFields
from synapse.api.errors import SynapseError
from synapse.events import EventBase # noqa: F401
from synapse.events.snapshot import EventContext # noqa: F401
@@ -1491,7 +1491,7 @@ class EventsStore(
self._handle_event_relations(txn, event)
# Store the labels for this event.
- labels = event.content.get(LabelsField)
+ labels = event.content.get(EventContentFields.Labels)
if labels:
self.insert_labels_for_event_txn(txn, event.event_id, labels)
@@ -2483,6 +2483,14 @@ class EventsStore(
)
def insert_labels_for_event_txn(self, txn, event_id, labels):
+ """Store the mapping between an event's ID and its labels, with one row per
+ (event_id, label) tuple.
+
+ Args:
+ txn (LoggingTransaction): The transaction to execute.
+ event_id (str): The event's ID.
+ labels (list[str]): A list of text labels.
+ """
return self._simple_insert_many_txn(
txn=txn,
table="event_labels",
diff --git a/tests/api/test_filtering.py b/tests/api/test_filtering.py
index e004ab1ee5..8ec48c4154 100644
--- a/tests/api/test_filtering.py
+++ b/tests/api/test_filtering.py
@@ -19,7 +19,7 @@ import jsonschema
from twisted.internet import defer
-from synapse.api.constants import LabelsField
+from synapse.api.constants import EventContentFields
from synapse.api.errors import SynapseError
from synapse.api.filtering import Filter
from synapse.events import FrozenEvent
@@ -329,7 +329,7 @@ class FilteringTestCase(unittest.TestCase):
sender="@foo:bar",
type="m.room.message",
room_id="!secretbase:unknown",
- content={LabelsField: ["#fun"]},
+ content={EventContentFields.Labels: ["#fun"]},
)
self.assertTrue(Filter(definition).check(event))
@@ -338,7 +338,7 @@ class FilteringTestCase(unittest.TestCase):
sender="@foo:bar",
type="m.room.message",
room_id="!secretbase:unknown",
- content={LabelsField: ["#notfun"]},
+ content={EventContentFields.Labels: ["#notfun"]},
)
self.assertFalse(Filter(definition).check(event))
@@ -349,7 +349,7 @@ class FilteringTestCase(unittest.TestCase):
sender="@foo:bar",
type="m.room.message",
room_id="!secretbase:unknown",
- content={LabelsField: ["#fun"]},
+ content={EventContentFields.Labels: ["#fun"]},
)
self.assertFalse(Filter(definition).check(event))
@@ -358,7 +358,7 @@ class FilteringTestCase(unittest.TestCase):
sender="@foo:bar",
type="m.room.message",
room_id="!secretbase:unknown",
- content={LabelsField: ["#notfun"]},
+ content={EventContentFields.Labels: ["#notfun"]},
)
self.assertTrue(Filter(definition).check(event))
diff --git a/tests/rest/client/v1/test_rooms.py b/tests/rest/client/v1/test_rooms.py
index 188f47bd7d..0dc0faa0e5 100644
--- a/tests/rest/client/v1/test_rooms.py
+++ b/tests/rest/client/v1/test_rooms.py
@@ -24,7 +24,7 @@ from six.moves.urllib import parse as urlparse
from twisted.internet import defer
import synapse.rest.admin
-from synapse.api.constants import EventTypes, LabelsField, Membership
+from synapse.api.constants import EventContentFields, EventTypes, Membership
from synapse.rest.client.v1 import login, profile, room
from tests import unittest
@@ -860,7 +860,7 @@ class RoomMessageListTestCase(RoomBase):
content={
"msgtype": "m.text",
"body": "with right label",
- LabelsField: ["#fun"],
+ EventContentFields.Labels: ["#fun"],
},
)
@@ -876,7 +876,7 @@ class RoomMessageListTestCase(RoomBase):
content={
"msgtype": "m.text",
"body": "with wrong label",
- LabelsField: ["#work"],
+ EventContentFields.Labels: ["#work"],
},
)
@@ -886,7 +886,7 @@ class RoomMessageListTestCase(RoomBase):
content={
"msgtype": "m.text",
"body": "with two wrong labels",
- LabelsField: ["#work", "#notfun"],
+ EventContentFields.Labels: ["#work", "#notfun"],
},
)
@@ -896,7 +896,7 @@ class RoomMessageListTestCase(RoomBase):
content={
"msgtype": "m.text",
"body": "with right label",
- LabelsField: ["#fun"],
+ EventContentFields.Labels: ["#fun"],
},
)
diff --git a/tests/rest/client/v2_alpha/test_sync.py b/tests/rest/client/v2_alpha/test_sync.py
index c5c199d412..c3c6f75ced 100644
--- a/tests/rest/client/v2_alpha/test_sync.py
+++ b/tests/rest/client/v2_alpha/test_sync.py
@@ -17,7 +17,7 @@ import json
from mock import Mock
import synapse.rest.admin
-from synapse.api.constants import EventTypes, LabelsField
+from synapse.api.constants import EventContentFields, EventTypes
from synapse.rest.client.v1 import login, room
from synapse.rest.client.v2_alpha import sync
@@ -157,7 +157,7 @@ class SyncFilterTestCase(unittest.HomeserverTestCase):
content={
"msgtype": "m.text",
"body": "with right label",
- LabelsField: ["#fun"],
+ EventContentFields.Labels: ["#fun"],
},
tok=tok,
)
@@ -175,7 +175,7 @@ class SyncFilterTestCase(unittest.HomeserverTestCase):
content={
"msgtype": "m.text",
"body": "with wrong label",
- LabelsField: ["#work"],
+ EventContentFields.Labels: ["#work"],
},
tok=tok,
)
@@ -186,7 +186,7 @@ class SyncFilterTestCase(unittest.HomeserverTestCase):
content={
"msgtype": "m.text",
"body": "with two wrong labels",
- LabelsField: ["#work", "#notfun"],
+ EventContentFields.Labels: ["#work", "#notfun"],
},
tok=tok,
)
@@ -197,7 +197,7 @@ class SyncFilterTestCase(unittest.HomeserverTestCase):
content={
"msgtype": "m.text",
"body": "with right label",
- LabelsField: ["#fun"],
+ EventContentFields.Labels: ["#fun"],
},
tok=tok,
)
|
