Skip to content
This repository was archived by the owner on Apr 26, 2024. It is now read-only.
Merged
Show file tree
Hide file tree
Changes from 1 commit
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions changelog.d/9581.feature
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
Add get_user_by_id method to ModuleApi.
12 changes: 11 additions & 1 deletion synapse/module_api/__init__.py
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@
# See the License for the specific language governing permissions and
# limitations under the License.
import logging
from typing import TYPE_CHECKING, Any, Generator, Iterable, Optional, Tuple
from typing import TYPE_CHECKING, Any, Dict, Generator, Iterable, Optional, Tuple

from twisted.internet import defer

Expand Down Expand Up @@ -72,6 +72,16 @@ def public_room_list_manager(self):
"""
return self._public_room_list_manager

def get_user_by_id(self, user_id: str) -> Optional[Dict[str, Any]]:
"""Get user by user_id

Args:
user_id: Fully qualified user id.
Returns:
the user dictionary or None if not found.
"""
return self._store.get_user_by_id(user_id)

def get_user_by_req(self, req, allow_guest=False):
"""Check the access_token provided for a request

Expand Down
5 changes: 5 additions & 0 deletions tests/module_api/test_api.py
Original file line number Diff line number Diff line change
Expand Up @@ -64,6 +64,11 @@ def test_can_register_user(self):
displayname = self.get_success(self.store.get_profile_displayname("bob"))
self.assertEqual(displayname, "Bobberino")

def test_get_user_by_id(self):
user_id = self.register_user("alice", "1234")
found_user = self.get_success(self.module_api.get_user_by_id(user_id))
self.assertTrue(found_user.get("name"), user_id)

def test_sending_events_into_room(self):
"""Tests that a module can send events into a room"""
# Mock out create_and_send_nonmember_event to check whether events are being sent
Expand Down