diff --git a/changelog.d/12624.misc b/changelog.d/12624.misc
new file mode 100644
index 0000000000..8772d40fa7
--- /dev/null
+++ b/changelog.d/12624.misc
@@ -0,0 +1 @@
+Remove use of constantly library and switch to enums for EventRedactBehaviour. Contributed by @andrewdoh.
diff --git a/mypy.ini b/mypy.ini
index 78699e3187..ba0de419f5 100644
--- a/mypy.ini
+++ b/mypy.ini
@@ -244,9 +244,6 @@ ignore_missing_imports = True
[mypy-canonicaljson]
ignore_missing_imports = True
-[mypy-constantly]
-ignore_missing_imports = True
-
[mypy-ijson.*]
ignore_missing_imports = True
diff --git a/synapse/handlers/events.py b/synapse/handlers/events.py
index 5b94b00bc3..82a5aac3dd 100644
--- a/synapse/handlers/events.py
+++ b/synapse/handlers/events.py
@@ -164,7 +164,7 @@ class EventHandler:
event.
"""
redact_behaviour = (
- EventRedactBehaviour.AS_IS if show_redacted else EventRedactBehaviour.REDACT
+ EventRedactBehaviour.as_is if show_redacted else EventRedactBehaviour.redact
)
event = await self.store.get_event(
event_id, check_room_id=room_id, redact_behaviour=redact_behaviour
diff --git a/synapse/handlers/federation.py b/synapse/handlers/federation.py
index d2ba70a814..38dc5b1f6e 100644
--- a/synapse/handlers/federation.py
+++ b/synapse/handlers/federation.py
@@ -316,7 +316,7 @@ class FederationHandler:
events_to_check = await self.store.get_events_as_list(
event_ids_to_check,
- redact_behaviour=EventRedactBehaviour.AS_IS,
+ redact_behaviour=EventRedactBehaviour.as_is,
get_prev_content=False,
)
@@ -1494,7 +1494,7 @@ class FederationHandler:
events = await self.store.get_events_as_list(
batch,
- redact_behaviour=EventRedactBehaviour.AS_IS,
+ redact_behaviour=EventRedactBehaviour.as_is,
allow_rejected=True,
)
for event in events:
diff --git a/synapse/handlers/federation_event.py b/synapse/handlers/federation_event.py
index 693b544286..6cf927e4ff 100644
--- a/synapse/handlers/federation_event.py
+++ b/synapse/handlers/federation_event.py
@@ -860,7 +860,7 @@ class FederationEventHandler:
evs = await self._store.get_events(
list(state_map.values()),
get_prev_content=False,
- redact_behaviour=EventRedactBehaviour.AS_IS,
+ redact_behaviour=EventRedactBehaviour.as_is,
)
event_map.update(evs)
diff --git a/synapse/handlers/message.py b/synapse/handlers/message.py
index 1b092e900e..95a89ac01f 100644
--- a/synapse/handlers/message.py
+++ b/synapse/handlers/message.py
@@ -1407,7 +1407,7 @@ class EventCreationHandler:
original_event = await self.store.get_event(
event.redacts,
- redact_behaviour=EventRedactBehaviour.AS_IS,
+ redact_behaviour=EventRedactBehaviour.as_is,
get_prev_content=False,
allow_rejected=False,
allow_none=True,
@@ -1504,7 +1504,7 @@ class EventCreationHandler:
original_event = await self.store.get_event(
event.redacts,
- redact_behaviour=EventRedactBehaviour.AS_IS,
+ redact_behaviour=EventRedactBehaviour.as_is,
get_prev_content=False,
allow_rejected=False,
allow_none=True,
diff --git a/synapse/state/__init__.py b/synapse/state/__init__.py
index fbf7ba4600..cad3b42640 100644
--- a/synapse/state/__init__.py
+++ b/synapse/state/__init__.py
@@ -800,7 +800,7 @@ class StateResolutionStore:
return self.store.get_events(
event_ids,
- redact_behaviour=EventRedactBehaviour.AS_IS,
+ redact_behaviour=EventRedactBehaviour.as_is,
get_prev_content=False,
allow_rejected=allow_rejected,
)
diff --git a/synapse/storage/databases/main/events_worker.py b/synapse/storage/databases/main/events_worker.py
index 0a48e5d29f..a4a604a499 100644
--- a/synapse/storage/databases/main/events_worker.py
+++ b/synapse/storage/databases/main/events_worker.py
@@ -14,6 +14,7 @@
import logging
import threading
+from enum import Enum, auto
from typing import (
TYPE_CHECKING,
Any,
@@ -30,7 +31,6 @@ from typing import (
)
import attr
-from constantly import NamedConstant, Names
from prometheus_client import Gauge
from typing_extensions import Literal
@@ -150,14 +150,14 @@ class _EventRow:
outlier: bool
-class EventRedactBehaviour(Names):
+class EventRedactBehaviour(Enum):
"""
What to do when retrieving a redacted event from the database.
"""
- AS_IS = NamedConstant()
- REDACT = NamedConstant()
- BLOCK = NamedConstant()
+ as_is = auto()
+ redact = auto()
+ block = auto()
class EventsWorkerStore(SQLBaseStore):
@@ -327,7 +327,7 @@ class EventsWorkerStore(SQLBaseStore):
async def get_event(
self,
event_id: str,
- redact_behaviour: EventRedactBehaviour = EventRedactBehaviour.REDACT,
+ redact_behaviour: EventRedactBehaviour = EventRedactBehaviour.redact,
get_prev_content: bool = ...,
allow_rejected: bool = ...,
allow_none: Literal[False] = ...,
@@ -339,7 +339,7 @@ class EventsWorkerStore(SQLBaseStore):
async def get_event(
self,
event_id: str,
- redact_behaviour: EventRedactBehaviour = EventRedactBehaviour.REDACT,
+ redact_behaviour: EventRedactBehaviour = EventRedactBehaviour.redact,
get_prev_content: bool = ...,
allow_rejected: bool = ...,
allow_none: Literal[True] = ...,
@@ -350,7 +350,7 @@ class EventsWorkerStore(SQLBaseStore):
async def get_event(
self,
event_id: str,
- redact_behaviour: EventRedactBehaviour = EventRedactBehaviour.REDACT,
+ redact_behaviour: EventRedactBehaviour = EventRedactBehaviour.redact,
get_prev_content: bool = False,
allow_rejected: bool = False,
allow_none: bool = False,
@@ -362,9 +362,9 @@ class EventsWorkerStore(SQLBaseStore):
event_id: The event_id of the event to fetch
redact_behaviour: Determine what to do with a redacted event. Possible values:
- * AS_IS - Return the full event body with no redacted content
- * REDACT - Return the event but with a redacted body
- * DISALLOW - Do not return redacted events (behave as per allow_none
+ * as_is - Return the full event body with no redacted content
+ * redact - Return the event but with a redacted body
+ * block - Do not return redacted events (behave as per allow_none
if the event is redacted)
get_prev_content: If True and event is a state event,
@@ -406,7 +406,7 @@ class EventsWorkerStore(SQLBaseStore):
async def get_events(
self,
event_ids: Collection[str],
- redact_behaviour: EventRedactBehaviour = EventRedactBehaviour.REDACT,
+ redact_behaviour: EventRedactBehaviour = EventRedactBehaviour.redact,
get_prev_content: bool = False,
allow_rejected: bool = False,
) -> Dict[str, EventBase]:
@@ -417,9 +417,9 @@ class EventsWorkerStore(SQLBaseStore):
redact_behaviour: Determine what to do with a redacted event. Possible
values:
- * AS_IS - Return the full event body with no redacted content
- * REDACT - Return the event but with a redacted body
- * DISALLOW - Do not return redacted events (omit them from the response)
+ * as_is - Return the full event body with no redacted content
+ * redact - Return the event but with a redacted body
+ * block - Do not return redacted events (omit them from the response)
get_prev_content: If True and event is a state event,
include the previous states content in the unsigned field.
@@ -442,7 +442,7 @@ class EventsWorkerStore(SQLBaseStore):
async def get_events_as_list(
self,
event_ids: Collection[str],
- redact_behaviour: EventRedactBehaviour = EventRedactBehaviour.REDACT,
+ redact_behaviour: EventRedactBehaviour = EventRedactBehaviour.redact,
get_prev_content: bool = False,
allow_rejected: bool = False,
) -> List[EventBase]:
@@ -455,9 +455,9 @@ class EventsWorkerStore(SQLBaseStore):
event_ids: The event_ids of the events to fetch
redact_behaviour: Determine what to do with a redacted event. Possible values:
- * AS_IS - Return the full event body with no redacted content
- * REDACT - Return the event but with a redacted body
- * DISALLOW - Do not return redacted events (omit them from the response)
+ * as_is - Return the full event body with no redacted content
+ * redact - Return the event but with a redacted body
+ * block - Do not return redacted events (omit them from the response)
get_prev_content: If True and event is a state event,
include the previous states content in the unsigned field.
@@ -568,10 +568,10 @@ class EventsWorkerStore(SQLBaseStore):
event = entry.event
if entry.redacted_event:
- if redact_behaviour == EventRedactBehaviour.BLOCK:
+ if redact_behaviour == EventRedactBehaviour.block:
# Skip this event
continue
- elif redact_behaviour == EventRedactBehaviour.REDACT:
+ elif redact_behaviour == EventRedactBehaviour.redact:
event = entry.redacted_event
events.append(event)
diff --git a/synapse/storage/databases/main/search.py b/synapse/storage/databases/main/search.py
index d4482c06db..3c49e7ec98 100644
--- a/synapse/storage/databases/main/search.py
+++ b/synapse/storage/databases/main/search.py
@@ -494,11 +494,11 @@ class SearchStore(SearchBackgroundUpdateStore):
results = list(filter(lambda row: row["room_id"] in room_ids, results))
- # We set redact_behaviour to BLOCK here to prevent redacted events being returned in
+ # We set redact_behaviour to block here to prevent redacted events being returned in
# search results (which is a data leak)
events = await self.get_events_as_list( # type: ignore[attr-defined]
[r["event_id"] for r in results],
- redact_behaviour=EventRedactBehaviour.BLOCK,
+ redact_behaviour=EventRedactBehaviour.block,
)
event_map = {ev.event_id: ev for ev in events}
@@ -652,11 +652,11 @@ class SearchStore(SearchBackgroundUpdateStore):
results = list(filter(lambda row: row["room_id"] in room_ids, results))
- # We set redact_behaviour to BLOCK here to prevent redacted events being returned in
+ # We set redact_behaviour to block here to prevent redacted events being returned in
# search results (which is a data leak)
events = await self.get_events_as_list( # type: ignore[attr-defined]
[r["event_id"] for r in results],
- redact_behaviour=EventRedactBehaviour.BLOCK,
+ redact_behaviour=EventRedactBehaviour.block,
)
event_map = {ev.event_id: ev for ev in events}
diff --git a/synapse/storage/databases/main/signatures.py b/synapse/storage/databases/main/signatures.py
index 95148fd227..05da15074a 100644
--- a/synapse/storage/databases/main/signatures.py
+++ b/synapse/storage/databases/main/signatures.py
@@ -48,7 +48,7 @@ class SignatureWorkerStore(EventsWorkerStore):
"""
events = await self.get_events(
event_ids,
- redact_behaviour=EventRedactBehaviour.AS_IS,
+ redact_behaviour=EventRedactBehaviour.as_is,
allow_rejected=True,
)
diff --git a/synapse/storage/persist_events.py b/synapse/storage/persist_events.py
index e496ba7bed..97118045a1 100644
--- a/synapse/storage/persist_events.py
+++ b/synapse/storage/persist_events.py
@@ -943,7 +943,7 @@ class EventsPersistenceStorage:
dropped_events = await self.main_store.get_events(
dropped_extrems,
allow_rejected=True,
- redact_behaviour=EventRedactBehaviour.AS_IS,
+ redact_behaviour=EventRedactBehaviour.as_is,
)
new_senders = {get_domain_from_id(e.sender) for e, _ in events_context}
@@ -974,7 +974,7 @@ class EventsPersistenceStorage:
prev_events = await self.main_store.get_events(
new_events,
allow_rejected=True,
- redact_behaviour=EventRedactBehaviour.AS_IS,
+ redact_behaviour=EventRedactBehaviour.as_is,
)
events_to_check = prev_events.values()
|
