From 495cb100d127212d55a46c177706d732950e70be Mon Sep 17 00:00:00 2001
From: Erik Johnston <erik@matrix.org>
Date: Mon, 6 Aug 2018 14:46:17 +0100
Subject: [PATCH 01/12] Allow profile changes to happen on workers
---
synapse/app/event_creator.py | 8 ++++
synapse/handlers/profile.py | 26 ++++++++--
synapse/replication/http/__init__.py | 3 +-
synapse/replication/http/profile.py | 71 ++++++++++++++++++++++++++++
synapse/storage/profile.py | 6 ++-
5 files changed, 106 insertions(+), 8 deletions(-)
create mode 100644 synapse/replication/http/profile.py
diff --git a/synapse/app/event_creator.py b/synapse/app/event_creator.py
index 374f115644..0c56fc777b 100644
--- a/synapse/app/event_creator.py
+++ b/synapse/app/event_creator.py
@@ -45,6 +45,11 @@ from synapse.replication.slave.storage.registration import SlavedRegistrationSto
from synapse.replication.slave.storage.room import RoomStore
from synapse.replication.slave.storage.transactions import TransactionStore
from synapse.replication.tcp.client import ReplicationClientHandler
+from synapse.rest.client.v1.profile import (
+ ProfileAvatarURLRestServlet,
+ ProfileDisplaynameRestServlet,
+ ProfileRestServlet,
+)
from synapse.rest.client.v1.room import (
JoinRoomAliasServlet,
RoomMembershipRestServlet,
@@ -101,6 +106,9 @@ class EventCreatorServer(HomeServer):
RoomMembershipRestServlet(self).register(resource)
RoomStateEventRestServlet(self).register(resource)
JoinRoomAliasServlet(self).register(resource)
+ ProfileAvatarURLRestServlet(self).register(resource)
+ ProfileDisplaynameRestServlet(self).register(resource)
+ ProfileRestServlet(self).register(resource)
resources.update({
"/_matrix/client/r0": resource,
"/_matrix/client/unstable": resource,
diff --git a/synapse/handlers/profile.py b/synapse/handlers/profile.py
index cb5c6d587e..a3bdb1830f 100644
--- a/synapse/handlers/profile.py
+++ b/synapse/handlers/profile.py
@@ -19,6 +19,7 @@ from twisted.internet import defer
from synapse.api.errors import AuthError, CodeMessageException, SynapseError
from synapse.metrics.background_process_metrics import run_as_background_process
+from synapse.replication.http.profile import ReplicationHandleProfileChangeRestServlet
from synapse.types import UserID, get_domain_from_id
from ._base import BaseHandler
@@ -45,6 +46,10 @@ class ProfileHandler(BaseHandler):
self._start_update_remote_profile_cache, self.PROFILE_UPDATE_MS,
)
+ self._notify_master_profile_change = (
+ ReplicationHandleProfileChangeRestServlet.make_client(hs)
+ )
+
@defer.inlineCallbacks
def get_profile(self, user_id):
target_user = UserID.from_string(user_id)
@@ -147,10 +152,16 @@ class ProfileHandler(BaseHandler):
)
if self.hs.config.user_directory_search_all_users:
- profile = yield self.store.get_profileinfo(target_user.localpart)
- yield self.user_directory_handler.handle_local_profile_change(
- target_user.to_string(), profile
- )
+ if self.hs.config.worker_app is None:
+ profile = yield self.store.get_profileinfo(target_user.localpart)
+ yield self.user_directory_handler.handle_local_profile_change(
+ target_user.to_string(), profile
+ )
+ else:
+ yield self._notify_master_profile_change(
+ requester=requester,
+ user_id=target_user.to_string(),
+ )
yield self._update_join_states(requester, target_user)
@@ -196,11 +207,16 @@ class ProfileHandler(BaseHandler):
target_user.localpart, new_avatar_url
)
- if self.hs.config.user_directory_search_all_users:
+ if self.hs.config.worker_app is None:
profile = yield self.store.get_profileinfo(target_user.localpart)
yield self.user_directory_handler.handle_local_profile_change(
target_user.to_string(), profile
)
+ else:
+ yield self._notify_master_profile_change(
+ requester=requester,
+ user_id=target_user.to_string(),
+ )
yield self._update_join_states(requester, target_user)
diff --git a/synapse/replication/http/__init__.py b/synapse/replication/http/__init__.py
index 589ee94c66..1fbbdf53e9 100644
--- a/synapse/replication/http/__init__.py
+++ b/synapse/replication/http/__init__.py
@@ -14,7 +14,7 @@
# limitations under the License.
from synapse.http.server import JsonResource
-from synapse.replication.http import membership, send_event
+from synapse.replication.http import membership, profile, send_event
REPLICATION_PREFIX = "/_synapse/replication"
@@ -27,3 +27,4 @@ class ReplicationRestResource(JsonResource):
def register_servlets(self, hs):
send_event.register_servlets(hs, self)
membership.register_servlets(hs, self)
+ profile.register_servlets(hs, self)
diff --git a/synapse/replication/http/profile.py b/synapse/replication/http/profile.py
new file mode 100644
index 0000000000..c4d54c936f
--- /dev/null
+++ b/synapse/replication/http/profile.py
@@ -0,0 +1,71 @@
+# -*- coding: utf-8 -*-
+# Copyright 2018 New Vector Ltd
+#
+# 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 logging
+
+from twisted.internet import defer
+
+from synapse.http.servlet import parse_json_object_from_request
+from synapse.replication.http._base import ReplicationEndpoint
+from synapse.types import Requester, UserID
+
+logger = logging.getLogger(__name__)
+
+
+class ReplicationHandleProfileChangeRestServlet(ReplicationEndpoint):
+ NAME = "profile_changed"
+ PATH_ARGS = ("user_id",)
+ POST = True
+
+ def __init__(self, hs):
+ super(ReplicationHandleProfileChangeRestServlet, self).__init__(hs)
+
+ self.user_directory_handler = hs.get_user_directory_handler()
+ self.store = hs.get_datastore()
+ self.clock = hs.get_clock()
+
+ @staticmethod
+ def _serialize_payload(requester, user_id):
+ """
+ Args:
+ requester (Requester)
+ user_id (str)
+ """
+
+ return {
+ "requester": requester.serialize(),
+ }
+
+ @defer.inlineCallbacks
+ def _handle_request(self, request, user_id):
+ content = parse_json_object_from_request(request)
+
+ requester = Requester.deserialize(self.store, content["requester"])
+
+ if requester.user:
+ request.authenticated_entity = requester.user.to_string()
+
+ target_user = UserID.from_string(user_id)
+
+ profile = yield self.store.get_profileinfo(target_user.localpart)
+ yield self.user_directory_handler.handle_local_profile_change(
+ user_id, profile
+ )
+
+ defer.returnValue((200, {}))
+
+
+def register_servlets(hs, http_server):
+ ReplicationHandleProfileChangeRestServlet(hs).register(http_server)
diff --git a/synapse/storage/profile.py b/synapse/storage/profile.py
index 60295da254..246ab836bd 100644
--- a/synapse/storage/profile.py
+++ b/synapse/storage/profile.py
@@ -71,8 +71,6 @@ class ProfileWorkerStore(SQLBaseStore):
desc="get_from_remote_profile_cache",
)
-
-class ProfileStore(ProfileWorkerStore):
def create_profile(self, user_localpart):
return self._simple_insert(
table="profiles",
@@ -182,3 +180,7 @@ class ProfileStore(ProfileWorkerStore):
if res:
defer.returnValue(True)
+
+
+class ProfileStore(ProfileWorkerStore):
+ pass
From cd9765805e2792ad7d6b0b014447f51d2b9add8c Mon Sep 17 00:00:00 2001
From: Erik Johnston <erik@matrix.org>
Date: Tue, 7 Aug 2018 10:48:31 +0100
Subject: [PATCH 02/12] Allow ratelimiting on workers
---
synapse/storage/room.py | 58 ++++++++++++++++++++---------------------
1 file changed, 29 insertions(+), 29 deletions(-)
diff --git a/synapse/storage/room.py b/synapse/storage/room.py
index 3147fb6827..1e473cc188 100644
--- a/synapse/storage/room.py
+++ b/synapse/storage/room.py
@@ -170,6 +170,35 @@ class RoomWorkerStore(SQLBaseStore):
desc="is_room_blocked",
)
+ @cachedInlineCallbacks(max_entries=10000)
+ def get_ratelimit_for_user(self, user_id):
+ """Check if there are any overrides for ratelimiting for the given
+ user
+
+ Args:
+ user_id (str)
+
+ Returns:
+ RatelimitOverride if there is an override, else None. If the contents
+ of RatelimitOverride are None or 0 then ratelimitng has been
+ disabled for that user entirely.
+ """
+ row = yield self._simple_select_one(
+ table="ratelimit_override",
+ keyvalues={"user_id": user_id},
+ retcols=("messages_per_second", "burst_count"),
+ allow_none=True,
+ desc="get_ratelimit_for_user",
+ )
+
+ if row:
+ defer.returnValue(RatelimitOverride(
+ messages_per_second=row["messages_per_second"],
+ burst_count=row["burst_count"],
+ ))
+ else:
+ defer.returnValue(None)
+
class RoomStore(RoomWorkerStore, SearchStore):
@@ -469,35 +498,6 @@ class RoomStore(RoomWorkerStore, SearchStore):
"get_all_new_public_rooms", get_all_new_public_rooms
)
- @cachedInlineCallbacks(max_entries=10000)
- def get_ratelimit_for_user(self, user_id):
- """Check if there are any overrides for ratelimiting for the given
- user
-
- Args:
- user_id (str)
-
- Returns:
- RatelimitOverride if there is an override, else None. If the contents
- of RatelimitOverride are None or 0 then ratelimitng has been
- disabled for that user entirely.
- """
- row = yield self._simple_select_one(
- table="ratelimit_override",
- keyvalues={"user_id": user_id},
- retcols=("messages_per_second", "burst_count"),
- allow_none=True,
- desc="get_ratelimit_for_user",
- )
-
- if row:
- defer.returnValue(RatelimitOverride(
- messages_per_second=row["messages_per_second"],
- burst_count=row["burst_count"],
- ))
- else:
- defer.returnValue(None)
-
@defer.inlineCallbacks
def block_room(self, room_id, user_id):
yield self._simple_insert(
From f81f4210869a65d68b256a82171ba8709649b61e Mon Sep 17 00:00:00 2001
From: Erik Johnston <erik@matrix.org>
Date: Tue, 7 Aug 2018 10:51:35 +0100
Subject: [PATCH 03/12] Update workers.rst with new paths
---
docs/workers.rst | 1 +
1 file changed, 1 insertion(+)
diff --git a/docs/workers.rst b/docs/workers.rst
index c5b37c3ded..72c0f289fb 100644
--- a/docs/workers.rst
+++ b/docs/workers.rst
@@ -244,6 +244,7 @@ Handles some event creation. It can handle REST endpoints matching::
^/_matrix/client/(api/v1|r0|unstable)/rooms/.*/send
^/_matrix/client/(api/v1|r0|unstable)/rooms/.*/(join|invite|leave|ban|unban|kick)$
^/_matrix/client/(api/v1|r0|unstable)/join/
+ ^/_matrix/client/(api/v1|r0|unstable)/profile/
It will create events locally and then send them on to the main synapse
instance to be persisted and handled.
From 54a9bea88c6df7107869d9a038a6f9a55d16e67b Mon Sep 17 00:00:00 2001
From: Erik Johnston <erik@matrix.org>
Date: Thu, 9 Aug 2018 10:39:29 +0100
Subject: [PATCH 04/12] Newsfile
---
changelog.d/3659.feature | 1 +
1 file changed, 1 insertion(+)
create mode 100644 changelog.d/3659.feature
diff --git a/changelog.d/3659.feature b/changelog.d/3659.feature
new file mode 100644
index 0000000000..a5b4821c09
--- /dev/null
+++ b/changelog.d/3659.feature
@@ -0,0 +1 @@
+Support profile API endpoints on workers
From a6c813761aa38d9ea0ff6db7303b25dfc7b77712 Mon Sep 17 00:00:00 2001
From: Erik Johnston <erik@matrix.org>
Date: Thu, 9 Aug 2018 10:41:08 +0100
Subject: [PATCH 05/12] Docstrings
---
synapse/replication/http/profile.py | 12 +++++++++++-
1 file changed, 11 insertions(+), 1 deletion(-)
diff --git a/synapse/replication/http/profile.py b/synapse/replication/http/profile.py
index c4d54c936f..aa700c2434 100644
--- a/synapse/replication/http/profile.py
+++ b/synapse/replication/http/profile.py
@@ -25,9 +25,19 @@ logger = logging.getLogger(__name__)
class ReplicationHandleProfileChangeRestServlet(ReplicationEndpoint):
+ """Notifies that a users profile has changed
+
+ Request format:
+
+ POST /_synapse/replication/profile_changed/:user_id
+
+ {
+ "requester": ...
+ }
+ """
+
NAME = "profile_changed"
PATH_ARGS = ("user_id",)
- POST = True
def __init__(self, hs):
super(ReplicationHandleProfileChangeRestServlet, self).__init__(hs)
From 38f708a2bbee13ebd34f1595910dd0e4fd532818 Mon Sep 17 00:00:00 2001
From: Erik Johnston <erik@matrix.org>
Date: Fri, 17 Aug 2018 11:37:42 +0100
Subject: [PATCH 06/12] Remote profile cache should remain in master worker
---
synapse/storage/profile.py | 6 ++----
1 file changed, 2 insertions(+), 4 deletions(-)
diff --git a/synapse/storage/profile.py b/synapse/storage/profile.py
index 246ab836bd..88b50f33b5 100644
--- a/synapse/storage/profile.py
+++ b/synapse/storage/profile.py
@@ -94,6 +94,8 @@ class ProfileWorkerStore(SQLBaseStore):
desc="set_profile_avatar_url",
)
+
+class ProfileStore(ProfileWorkerStore):
def add_remote_profile_cache(self, user_id, displayname, avatar_url):
"""Ensure we are caching the remote user's profiles.
@@ -180,7 +182,3 @@ class ProfileWorkerStore(SQLBaseStore):
if res:
defer.returnValue(True)
-
-
-class ProfileStore(ProfileWorkerStore):
- pass
From ca87ad1defac1082462367854cb4a656b7a96e90 Mon Sep 17 00:00:00 2001
From: Erik Johnston <erik@matrix.org>
Date: Fri, 17 Aug 2018 11:43:16 +0100
Subject: [PATCH 07/12] Split ProfileHandler into master and worker
---
synapse/handlers/profile.py | 21 ++++++++++++++-------
synapse/server.py | 7 +++++--
tests/handlers/test_profile.py | 4 ++--
3 files changed, 21 insertions(+), 11 deletions(-)
diff --git a/synapse/handlers/profile.py b/synapse/handlers/profile.py
index 6d1fbb1a5c..8b349f6ad6 100644
--- a/synapse/handlers/profile.py
+++ b/synapse/handlers/profile.py
@@ -33,12 +33,12 @@ from ._base import BaseHandler
logger = logging.getLogger(__name__)
-class ProfileHandler(BaseHandler):
+class WorkerProfileHandler(BaseHandler):
PROFILE_UPDATE_MS = 60 * 1000
PROFILE_UPDATE_EVERY_MS = 24 * 60 * 60 * 1000
def __init__(self, hs):
- super(ProfileHandler, self).__init__(hs)
+ super(WorkerProfileHandler, self).__init__(hs)
self.federation = hs.get_federation_client()
hs.get_federation_registry().register_query_handler(
@@ -47,11 +47,6 @@ class ProfileHandler(BaseHandler):
self.user_directory_handler = hs.get_user_directory_handler()
- if hs.config.worker_app is None:
- self.clock.looping_call(
- self._start_update_remote_profile_cache, self.PROFILE_UPDATE_MS,
- )
-
self._notify_master_profile_change = (
ReplicationHandleProfileChangeRestServlet.make_client(hs)
)
@@ -298,6 +293,18 @@ class ProfileHandler(BaseHandler):
room_id, str(e.message)
)
+
+class MasterProfileHandler(WorkerProfileHandler):
+ PROFILE_UPDATE_MS = 60 * 1000
+ PROFILE_UPDATE_EVERY_MS = 24 * 60 * 60 * 1000
+
+ def __init__(self, hs):
+ super(MasterProfileHandler, self).__init__(hs)
+
+ self.clock.looping_call(
+ self._start_update_remote_profile_cache, self.PROFILE_UPDATE_MS,
+ )
+
def _start_update_remote_profile_cache(self):
return run_as_background_process(
"Update remote profile", self._update_remote_profile_cache,
diff --git a/synapse/server.py b/synapse/server.py
index 140be9ebe8..be85aad8cf 100644
--- a/synapse/server.py
+++ b/synapse/server.py
@@ -55,7 +55,7 @@ from synapse.handlers.initial_sync import InitialSyncHandler
from synapse.handlers.message import EventCreationHandler, MessageHandler
from synapse.handlers.pagination import PaginationHandler
from synapse.handlers.presence import PresenceHandler
-from synapse.handlers.profile import ProfileHandler
+from synapse.handlers.profile import MasterProfileHandler, WorkerProfileHandler
from synapse.handlers.read_marker import ReadMarkerHandler
from synapse.handlers.receipts import ReceiptsHandler
from synapse.handlers.room import RoomContextHandler, RoomCreationHandler
@@ -307,7 +307,10 @@ class HomeServer(object):
return InitialSyncHandler(self)
def build_profile_handler(self):
- return ProfileHandler(self)
+ if self.config.worker_app:
+ return WorkerProfileHandler(self)
+ else:
+ return MasterProfileHandler(self)
def build_event_creation_handler(self):
return EventCreationHandler(self)
diff --git a/tests/handlers/test_profile.py b/tests/handlers/test_profile.py
index dc17918a3d..07cf5f4c8e 100644
--- a/tests/handlers/test_profile.py
+++ b/tests/handlers/test_profile.py
@@ -20,7 +20,7 @@ from twisted.internet import defer
import synapse.types
from synapse.api.errors import AuthError
-from synapse.handlers.profile import ProfileHandler
+from synapse.handlers.profile import MasterProfileHandler
from synapse.types import UserID
from tests import unittest
@@ -29,7 +29,7 @@ from tests.utils import setup_test_homeserver
class ProfileHandlers(object):
def __init__(self, hs):
- self.profile_handler = ProfileHandler(hs)
+ self.profile_handler = MasterProfileHandler(hs)
class ProfileTestCase(unittest.TestCase):
From 91cdb6de08aa20f2bc7f8df906eb5b56df387309 Mon Sep 17 00:00:00 2001
From: Erik Johnston <erik@matrix.org>
Date: Fri, 17 Aug 2018 15:24:16 +0100
Subject: [PATCH 08/12] Call UserDirectoryHandler methods directly
Turns out that the user directory handling is fairly racey as a bunch
of stuff assumes that the processing happens on master, which it doesn't
when there is a synapse.app.user_dir worker. So lets just call the
function directly until we actually get round to fixing it, since it
doesn't make the situation any worse.
---
synapse/app/event_creator.py | 2 +
synapse/handlers/profile.py | 26 ++-------
synapse/replication/http/__init__.py | 3 +-
synapse/replication/http/profile.py | 81 ----------------------------
4 files changed, 8 insertions(+), 104 deletions(-)
delete mode 100644 synapse/replication/http/profile.py
diff --git a/synapse/app/event_creator.py b/synapse/app/event_creator.py
index 2c9a735859..a2bdaf2a2c 100644
--- a/synapse/app/event_creator.py
+++ b/synapse/app/event_creator.py
@@ -58,6 +58,7 @@ from synapse.rest.client.v1.room import (
)
from synapse.server import HomeServer
from synapse.storage.engines import create_engine
+from synapse.storage.user_directory import UserDirectoryStore
from synapse.util.httpresourcetree import create_resource_tree
from synapse.util.logcontext import LoggingContext
from synapse.util.manhole import manhole
@@ -67,6 +68,7 @@ logger = logging.getLogger("synapse.app.event_creator")
class EventCreatorSlavedStore(
+ UserDirectoryStore,
DirectoryStore,
SlavedTransactionStore,
SlavedProfileStore,
diff --git a/synapse/handlers/profile.py b/synapse/handlers/profile.py
index 8b349f6ad6..3e1d95d5e5 100644
--- a/synapse/handlers/profile.py
+++ b/synapse/handlers/profile.py
@@ -25,7 +25,6 @@ from synapse.api.errors import (
SynapseError,
)
from synapse.metrics.background_process_metrics import run_as_background_process
-from synapse.replication.http.profile import ReplicationHandleProfileChangeRestServlet
from synapse.types import UserID, get_domain_from_id
from ._base import BaseHandler
@@ -47,10 +46,6 @@ class WorkerProfileHandler(BaseHandler):
self.user_directory_handler = hs.get_user_directory_handler()
- self._notify_master_profile_change = (
- ReplicationHandleProfileChangeRestServlet.make_client(hs)
- )
-
@defer.inlineCallbacks
def get_profile(self, user_id):
target_user = UserID.from_string(user_id)
@@ -166,16 +161,10 @@ class WorkerProfileHandler(BaseHandler):
)
if self.hs.config.user_directory_search_all_users:
- if self.hs.config.worker_app is None:
- profile = yield self.store.get_profileinfo(target_user.localpart)
- yield self.user_directory_handler.handle_local_profile_change(
- target_user.to_string(), profile
- )
- else:
- yield self._notify_master_profile_change(
- requester=requester,
- user_id=target_user.to_string(),
- )
+ profile = yield self.store.get_profileinfo(target_user.localpart)
+ yield self.user_directory_handler.handle_local_profile_change(
+ target_user.to_string(), profile
+ )
yield self._update_join_states(requester, target_user)
@@ -225,16 +214,11 @@ class WorkerProfileHandler(BaseHandler):
target_user.localpart, new_avatar_url
)
- if self.hs.config.worker_app is None:
+ if self.hs.config.user_directory_search_all_users:
profile = yield self.store.get_profileinfo(target_user.localpart)
yield self.user_directory_handler.handle_local_profile_change(
target_user.to_string(), profile
)
- else:
- yield self._notify_master_profile_change(
- requester=requester,
- user_id=target_user.to_string(),
- )
yield self._update_join_states(requester, target_user)
diff --git a/synapse/replication/http/__init__.py b/synapse/replication/http/__init__.py
index d8487df614..19f214281e 100644
--- a/synapse/replication/http/__init__.py
+++ b/synapse/replication/http/__init__.py
@@ -14,7 +14,7 @@
# limitations under the License.
from synapse.http.server import JsonResource
-from synapse.replication.http import federation, membership, profile, send_event
+from synapse.replication.http import federation, membership, send_event
REPLICATION_PREFIX = "/_synapse/replication"
@@ -27,5 +27,4 @@ class ReplicationRestResource(JsonResource):
def register_servlets(self, hs):
send_event.register_servlets(hs, self)
membership.register_servlets(hs, self)
- profile.register_servlets(hs, self)
federation.register_servlets(hs, self)
diff --git a/synapse/replication/http/profile.py b/synapse/replication/http/profile.py
deleted file mode 100644
index aa700c2434..0000000000
--- a/synapse/replication/http/profile.py
+++ /dev/null
@@ -1,81 +0,0 @@
-# -*- coding: utf-8 -*-
-# Copyright 2018 New Vector Ltd
-#
-# 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 logging
-
-from twisted.internet import defer
-
-from synapse.http.servlet import parse_json_object_from_request
-from synapse.replication.http._base import ReplicationEndpoint
-from synapse.types import Requester, UserID
-
-logger = logging.getLogger(__name__)
-
-
-class ReplicationHandleProfileChangeRestServlet(ReplicationEndpoint):
- """Notifies that a users profile has changed
-
- Request format:
-
- POST /_synapse/replication/profile_changed/:user_id
-
- {
- "requester": ...
- }
- """
-
- NAME = "profile_changed"
- PATH_ARGS = ("user_id",)
-
- def __init__(self, hs):
- super(ReplicationHandleProfileChangeRestServlet, self).__init__(hs)
-
- self.user_directory_handler = hs.get_user_directory_handler()
- self.store = hs.get_datastore()
- self.clock = hs.get_clock()
-
- @staticmethod
- def _serialize_payload(requester, user_id):
- """
- Args:
- requester (Requester)
- user_id (str)
- """
-
- return {
- "requester": requester.serialize(),
- }
-
- @defer.inlineCallbacks
- def _handle_request(self, request, user_id):
- content = parse_json_object_from_request(request)
-
- requester = Requester.deserialize(self.store, content["requester"])
-
- if requester.user:
- request.authenticated_entity = requester.user.to_string()
-
- target_user = UserID.from_string(user_id)
-
- profile = yield self.store.get_profileinfo(target_user.localpart)
- yield self.user_directory_handler.handle_local_profile_change(
- user_id, profile
- )
-
- defer.returnValue((200, {}))
-
-
-def register_servlets(hs, http_server):
- ReplicationHandleProfileChangeRestServlet(hs).register(http_server)
From ab822a2d1fa30514185aa257b5c6a0af39a6f5f0 Mon Sep 17 00:00:00 2001
From: Erik Johnston <erik@matrix.org>
Date: Fri, 17 Aug 2018 15:30:31 +0100
Subject: [PATCH 09/12] Add some fixmes
---
synapse/app/event_creator.py | 2 ++
synapse/handlers/user_directory.py | 4 ++++
2 files changed, 6 insertions(+)
diff --git a/synapse/app/event_creator.py b/synapse/app/event_creator.py
index a2bdaf2a2c..a34c89fa99 100644
--- a/synapse/app/event_creator.py
+++ b/synapse/app/event_creator.py
@@ -68,6 +68,8 @@ logger = logging.getLogger("synapse.app.event_creator")
class EventCreatorSlavedStore(
+ # FIXME(#3714): We need to add UserDirectoryStore as we write directly
+ # rather than going via the correct worker.
UserDirectoryStore,
DirectoryStore,
SlavedTransactionStore,
diff --git a/synapse/handlers/user_directory.py b/synapse/handlers/user_directory.py
index 37dda64587..d8413d6aa7 100644
--- a/synapse/handlers/user_directory.py
+++ b/synapse/handlers/user_directory.py
@@ -119,6 +119,8 @@ class UserDirectoryHandler(object):
"""Called to update index of our local user profiles when they change
irrespective of any rooms the user may be in.
"""
+ # FIXME(#3714): We should probably do this in the same worker as all
+ # the other changes.
yield self.store.update_profile_in_user_dir(
user_id, profile.display_name, profile.avatar_url, None,
)
@@ -127,6 +129,8 @@ class UserDirectoryHandler(object):
def handle_user_deactivated(self, user_id):
"""Called when a user ID is deactivated
"""
+ # FIXME(#3714): We should probably do this in the same worker as all
+ # the other changes.
yield self.store.remove_from_user_dir(user_id)
yield self.store.remove_from_user_in_public_room(user_id)
From 47b25ba5f3040d07f8be80584b292ca0386fdb30 Mon Sep 17 00:00:00 2001
From: Erik Johnston <erik@matrix.org>
Date: Wed, 22 Aug 2018 10:09:05 +0100
Subject: [PATCH 10/12] Remove redundant vars
---
synapse/handlers/profile.py | 3 ---
1 file changed, 3 deletions(-)
diff --git a/synapse/handlers/profile.py b/synapse/handlers/profile.py
index 3e1d95d5e5..ec9cb1f50c 100644
--- a/synapse/handlers/profile.py
+++ b/synapse/handlers/profile.py
@@ -33,9 +33,6 @@ logger = logging.getLogger(__name__)
class WorkerProfileHandler(BaseHandler):
- PROFILE_UPDATE_MS = 60 * 1000
- PROFILE_UPDATE_EVERY_MS = 24 * 60 * 60 * 1000
-
def __init__(self, hs):
super(WorkerProfileHandler, self).__init__(hs)
From a81f1408807683d212b7bf3c4f5f36df4b0e0d33 Mon Sep 17 00:00:00 2001
From: Erik Johnston <erik@matrix.org>
Date: Wed, 22 Aug 2018 10:11:21 +0100
Subject: [PATCH 11/12] Add assert to ensure handler is only run on master
---
synapse/handlers/profile.py | 2 ++
1 file changed, 2 insertions(+)
diff --git a/synapse/handlers/profile.py b/synapse/handlers/profile.py
index ec9cb1f50c..278f131d5e 100644
--- a/synapse/handlers/profile.py
+++ b/synapse/handlers/profile.py
@@ -282,6 +282,8 @@ class MasterProfileHandler(WorkerProfileHandler):
def __init__(self, hs):
super(MasterProfileHandler, self).__init__(hs)
+ assert hs.config.worker_app is None
+
self.clock.looping_call(
self._start_update_remote_profile_cache, self.PROFILE_UPDATE_MS,
)
From 8432e2ebd76d0462d39a329967671e845da7e404 Mon Sep 17 00:00:00 2001
From: Erik Johnston <erik@matrix.org>
Date: Wed, 22 Aug 2018 10:13:40 +0100
Subject: [PATCH 12/12] Rename WorkerProfileHandler to BaseProfileHandler
---
synapse/handlers/profile.py | 13 ++++++++++---
synapse/server.py | 4 ++--
2 files changed, 12 insertions(+), 5 deletions(-)
diff --git a/synapse/handlers/profile.py b/synapse/handlers/profile.py
index 278f131d5e..75b8b7ce6a 100644
--- a/synapse/handlers/profile.py
+++ b/synapse/handlers/profile.py
@@ -32,9 +32,16 @@ from ._base import BaseHandler
logger = logging.getLogger(__name__)
-class WorkerProfileHandler(BaseHandler):
+class BaseProfileHandler(BaseHandler):
+ """Handles fetching and updating user profile information.
+
+ BaseProfileHandler can be instantiated directly on workers and will
+ delegate to master when necessary. The master process should use the
+ subclass MasterProfileHandler
+ """
+
def __init__(self, hs):
- super(WorkerProfileHandler, self).__init__(hs)
+ super(BaseProfileHandler, self).__init__(hs)
self.federation = hs.get_federation_client()
hs.get_federation_registry().register_query_handler(
@@ -275,7 +282,7 @@ class WorkerProfileHandler(BaseHandler):
)
-class MasterProfileHandler(WorkerProfileHandler):
+class MasterProfileHandler(BaseProfileHandler):
PROFILE_UPDATE_MS = 60 * 1000
PROFILE_UPDATE_EVERY_MS = 24 * 60 * 60 * 1000
diff --git a/synapse/server.py b/synapse/server.py
index fcfa7e6557..a6fbc6ec0c 100644
--- a/synapse/server.py
+++ b/synapse/server.py
@@ -56,7 +56,7 @@ from synapse.handlers.initial_sync import InitialSyncHandler
from synapse.handlers.message import EventCreationHandler, MessageHandler
from synapse.handlers.pagination import PaginationHandler
from synapse.handlers.presence import PresenceHandler
-from synapse.handlers.profile import MasterProfileHandler, WorkerProfileHandler
+from synapse.handlers.profile import BaseProfileHandler, MasterProfileHandler
from synapse.handlers.read_marker import ReadMarkerHandler
from synapse.handlers.receipts import ReceiptsHandler
from synapse.handlers.room import RoomContextHandler, RoomCreationHandler
@@ -309,7 +309,7 @@ class HomeServer(object):
def build_profile_handler(self):
if self.config.worker_app:
- return WorkerProfileHandler(self)
+ return BaseProfileHandler(self)
else:
return MasterProfileHandler(self)