Wrap register_device coroutine in an ensureDeferred (#7684)

Fixes https://github.com/matrix-org/synapse/issues/7683

Broke in: #7649

We had a `yield` acting on a coroutine. To be fair this one is a bit difficult to notice as there's a function in the middle that just passes the coroutine along.
This commit is contained in:
Andrew Morgan 2020-06-16 10:13:59 +01:00 committed by GitHub
parent 356243f08a
commit 3e6b5bba71
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
4 changed files with 62 additions and 5 deletions

1
changelog.d/7684.bugfix Normal file
View File

@ -0,0 +1 @@
Fix a bug that would crash Synapse on start when using certain password auth providers. Broke in release v1.15.0.

View File

@ -126,7 +126,7 @@ class ModuleApi(object):
'errcode' property for more information on the reason for failure 'errcode' property for more information on the reason for failure
Returns: Returns:
Deferred[str]: user_id defer.Deferred[str]: user_id
""" """
return defer.ensureDeferred( return defer.ensureDeferred(
self._hs.get_registration_handler().register_user( self._hs.get_registration_handler().register_user(
@ -149,11 +149,13 @@ class ModuleApi(object):
Returns: Returns:
defer.Deferred[tuple[str, str]]: Tuple of device ID and access token defer.Deferred[tuple[str, str]]: Tuple of device ID and access token
""" """
return self._hs.get_registration_handler().register_device( return defer.ensureDeferred(
self._hs.get_registration_handler().register_device(
user_id=user_id, user_id=user_id,
device_id=device_id, device_id=device_id,
initial_display_name=initial_display_name, initial_display_name=initial_display_name,
) )
)
def record_user_external_id( def record_user_external_id(
self, auth_provider_id: str, remote_user_id: str, registered_user_id: str self, auth_provider_id: str, remote_user_id: str, registered_user_id: str

View File

View File

@ -0,0 +1,54 @@
# -*- coding: utf-8 -*-
# Copyright 2020 The Matrix.org Foundation C.I.C.
#
# 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.
from synapse.module_api import ModuleApi
from tests.unittest import HomeserverTestCase
class ModuleApiTestCase(HomeserverTestCase):
def prepare(self, reactor, clock, homeserver):
self.store = homeserver.get_datastore()
self.module_api = ModuleApi(homeserver, homeserver.get_auth_handler())
def test_can_register_user(self):
"""Tests that an external module can register a user"""
# Register a new user
user_id, access_token = self.get_success(
self.module_api.register(
"bob", displayname="Bobberino", emails=["bob@bobinator.bob"]
)
)
# Check that the new user exists with all provided attributes
self.assertEqual(user_id, "@bob:test")
self.assertTrue(access_token)
self.assertTrue(self.store.get_user_by_id(user_id))
# Check that the email was assigned
emails = self.get_success(self.store.user_get_threepids(user_id))
self.assertEqual(len(emails), 1)
email = emails[0]
self.assertEqual(email["medium"], "email")
self.assertEqual(email["address"], "bob@bobinator.bob")
# Should these be 0?
self.assertEqual(email["validated_at"], 0)
self.assertEqual(email["added_at"], 0)
# Check that the displayname was assigned
displayname = self.get_success(self.store.get_profile_displayname("bob"))
self.assertEqual(displayname, "Bobberino")