Skip to content

Commit

Permalink
Cache literal sync filter validation (#17186)
Browse files Browse the repository at this point in the history
The sliding sync proxy (amongst other things) use literal json blobs as
filters, and repeatedly validating them takes a bunch of CPU.
  • Loading branch information
erikjohnston committed May 14, 2024
1 parent ebe7738 commit 284d85d
Show file tree
Hide file tree
Showing 2 changed files with 14 additions and 1 deletion.
1 change: 1 addition & 0 deletions changelog.d/17186.misc
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
Cache literal sync filter validation for performance.
14 changes: 13 additions & 1 deletion synapse/rest/client/sync.py
Original file line number Diff line number Diff line change
Expand Up @@ -47,6 +47,7 @@
from synapse.logging.opentracing import trace_with_opname
from synapse.types import JsonDict, Requester, StreamToken
from synapse.util import json_decoder
from synapse.util.caches.lrucache import LruCache

from ._base import client_patterns, set_timeline_upper_limit

Expand Down Expand Up @@ -110,6 +111,11 @@ def __init__(self, hs: "HomeServer"):
self._msc2654_enabled = hs.config.experimental.msc2654_enabled
self._msc3773_enabled = hs.config.experimental.msc3773_enabled

self._json_filter_cache: LruCache[str, bool] = LruCache(
max_size=1000,
cache_name="sync_valid_filter",
)

async def on_GET(self, request: SynapseRequest) -> Tuple[int, JsonDict]:
# This will always be set by the time Twisted calls us.
assert request.args is not None
Expand Down Expand Up @@ -177,7 +183,13 @@ async def on_GET(self, request: SynapseRequest) -> Tuple[int, JsonDict]:
filter_object = json_decoder.decode(filter_id)
except Exception:
raise SynapseError(400, "Invalid filter JSON", errcode=Codes.NOT_JSON)
self.filtering.check_valid_filter(filter_object)

# We cache the validation, as this can get quite expensive if people use
# a literal json blob as a query param.
if not self._json_filter_cache.get(filter_id):
self.filtering.check_valid_filter(filter_object)
self._json_filter_cache[filter_id] = True

set_timeline_upper_limit(
filter_object, self.hs.config.server.filter_timeline_limit
)
Expand Down

0 comments on commit 284d85d

Please sign in to comment.