Autocreate autojoin rooms #3975

ara4n · 2018-09-28T00:43:37Z

Needed for HHS.

richvdh · 2018-10-01T11:14:07Z

synapse/handlers/register.py

+        # try to create the room if we're the first user on the server
+        if self.hs.config.autocreate_auto_join_rooms:
+            count = yield self.store.count_all_users()
+            if count == 1 and RoomAlias.is_valid(room_identifier):


it feels very random to be doing this at this point. (Which is when the first user is registered? when they log in?). what if two users register at once? what if the first user didn't qualify for autojoining for some reason?

Can we not do this when the HS first starts, somehow?

the only way to do it at start would be if we also autocreated an admin user, which in turn then means shared-secret registering them and then setting up their profile and 3pid and passwords etc correctly. agreed this would be cleaner, but this is intended as a fast fix to avoid having to do that in the provisioning process, on the basis that the first user who signs in is 99% always going to be the server admin, and if it isn't, then you can always repoint the alias.

ok, fair enough, but still, having _join_user_to_room magically do something different if there is now exactly one registered user feels very magical.

can we pull out the is this the first user logic to register (where we only have to do it once per user, rather than once per user per room)? and have a separate _create_auto_join_room method?

and have a separate _create_auto_join_room method

or just call room_creation_handler.create_room directly from the for r in self.hs.config.auto_join_rooms loop in register.

richvdh · 2018-10-01T11:17:29Z

synapse/handlers/register.py

+                )
+                room_id = info["room_id"]
+
+                directory_handler = self.hs.get_handlers().directory_handler


can we not do the alias bits by passing room_alias_name to create_room ?

oh, possibly.

richvdh · 2018-10-01T11:26:39Z

Also: we're not happy with this going in with zero tests to make sure it doesn't suddenly break in the future. It's going to be hard to sytest, but please can it have some unit tests to run the code?

ara4n · 2018-10-01T12:07:28Z

before I go rewrite this, it'd be good to get aligned on the proposed behaviour in general; the current implementation was a quick fix i suggested to @neilisfragile so we could get this feature out quickly rather than getting entangled with complicated provisioning/auth rejigs.

maxidorius · 2018-10-01T15:11:58Z

What is HHS ?

ara4n · 2018-10-01T16:03:49Z

HHS === modular.im

neilisfragile · 2018-10-03T10:41:23Z

Need to think about gdpr consent and ability to create rooms, could be dependent on element-hq/element-web#7168

neilisfragile · 2018-10-05T15:09:42Z

Blocked on #4004

turt2live · 2018-10-05T21:31:27Z

Blocked how? This and #4004 are unrelated changes

neilisfragile · 2018-10-06T19:33:16Z

It's currently not possible to create the room prior to consent, so the room is never created on GDPR compliant servers. I suppose you could instead tie room creation into the first user to consent, but given you are already working on moving consent earlier in the flow it seems sensible just to wait for it to land then this PR will magically work.

neil seems to have fixed this

richvdh · 2018-10-10T10:39:39Z

changelog.d/3975.feature

@@ -0,0 +1 @@
+First user should autocreate autojoin rooms


could you expand on this a bit so that it makes sense for users, please?

richvdh · 2018-10-10T10:40:24Z

synapse/config/registration.py

@@ -98,6 +99,9 @@ def default_config(self, **kwargs):
        # to these rooms
        #auto_join_rooms:
        #    - "#example:example.com"
+
+        # Have first user on server autocreate autojoin rooms


maybe explain what will happen if it is false, and conversely what happens if it is true?

richvdh · 2018-10-10T10:49:27Z

synapse/handlers/register.py

        for r in self.hs.config.auto_join_rooms:
            try:
+                if auto_create_rooms and RoomAlias.is_valid(r):
+                    room_creation_handler = self.hs.get_room_creation_handler()


can you put this in the constructor?

The first part needs to be on a request basis - I guess the self.hs.get_room_creation_handler() could but this is the only place it is used.

I know it's the only place it's used, but we prefer to get the handlers in the constructors where possible, so that we detect problems earlier.

richvdh · 2018-10-10T10:50:42Z

synapse/handlers/register.py

        for r in self.hs.config.auto_join_rooms:
            try:
+                if auto_create_rooms and RoomAlias.is_valid(r):


if the alias is invalid, we silently ignore it? If you're going to sanity check it, put the sanity check in the config module, and raise a ConfigError if it's wrong.

richvdh · 2018-10-10T10:53:04Z

synapse/handlers/register.py

+        # try to create the room if we're the first user on the server
+        if self.hs.config.autocreate_auto_join_rooms:
+            count = yield self.store.count_all_users()
+            auto_create_rooms = count == 1


you need to initialise auto_create_rooms for the case where autocreate_auto_join_rooms is False.

synapse/handlers/register.py

richvdh · 2018-10-10T10:56:32Z

synapse/handlers/register.py

@@ -513,6 +531,7 @@ def get_or_register_3pid_guest(self, medium, address, inviter_user_id):

    @defer.inlineCallbacks
    def _join_user_to_room(self, requester, room_identifier):
+


it was oversight I promise!

richvdh · 2018-10-10T10:57:02Z

tests/handlers/test_register.py

        )
        self.macaroon_generator = Mock(
            generate_access_token=Mock(return_value='secret')
        )
        self.hs.get_macaroon_generator = Mock(return_value=self.macaroon_generator)
-        self.hs.handlers = RegistrationHandlers(self.hs)
+        # self.hs.handlers = RegistrationHandlers(self.hs)


if it's redundant, remove it, don't comment it out

richvdh · 2018-10-10T10:58:43Z

tests/handlers/test_register.py

+    @defer.inlineCallbacks
+    def test_auto_create_auto_join_rooms(self):
+        room_alias_str = "#room:test"
+        self.hs.config.autocreate_auto_join_rooms = True


this seems to be the default; you could argue it should be set here for certainty but in that case let's have a comment. else just remove it

richvdh · 2018-10-10T10:59:22Z

tests/handlers/test_register.py

+        self.assertEqual(len(rooms), 1)
+
+    @defer.inlineCallbacks
+    def test_auto_create_auto_join_rooms_with_no_rooms(self):


can we also have a UT with autocreate_auto_join_rooms=False please?

martindale · 2018-10-12T17:25:42Z

Could portions of this be used to auto-create a room for each user? Useful for creating notes channels, etc. for workflow-specific applications.

richvdh · 2018-10-17T08:21:11Z

changelog.d/3975.feature

@@ -1 +1 @@
-First user should autocreate autojoin rooms
+Servers with auto join rooms, should autocreate those rooms when first user registers


s/auto join/auto-join/

s/should/will now/

s/first user/the first user/

possibly, s/autocreate/automatically create/

richvdh · 2018-10-17T08:23:15Z

synapse/config/registration.py

@@ -15,6 +15,8 @@

 from distutils.util import strtobool

+from synapse.config._base import ConfigError
+from synapse.types import RoomAlias
 from synapse.util.stringutils import random_string_with_symbols

 from ._base import Config


it'd be nice to merge this into line 18 while you're at it (absolute imports are preferred over relative ones)

richvdh · 2018-10-17T08:24:25Z

synapse/config/registration.py

@@ -44,6 +46,9 @@ def read_config(self, config):
        )

        self.auto_join_rooms = config.get("auto_join_rooms", [])
+        for room_alias in self.auto_join_rooms:
+            if not RoomAlias.is_valid(room_alias):
+                raise ConfigError('Invalid auto_join_rooms entry %s' % room_alias)


generally prefer % (room_alias, ) in case room_alias turns out to be a tuple

richvdh · 2018-10-17T08:24:45Z

synapse/config/registration.py

@@ -100,7 +105,11 @@ def default_config(self, **kwargs):
        #auto_join_rooms:
        #    - "#example:example.com"

-        # Have first user on server autocreate autojoin rooms
+        # Where auto_join_rooms are specified, setting this flag ensures that the
+        # the rooms exists by creating them when the first user on the


s/exists/exist/

richvdh · 2018-10-17T08:25:06Z

synapse/config/registration.py

+        # the rooms exists by creating them when the first user on the
+        # homeserver registers.
+        # Setting to false means that if the rooms are not manually created,
+        # users cannot be auto joined since they do not exist.


s/auto joined/auto-joined/

richvdh · 2018-10-17T08:27:23Z

synapse/handlers/register.py

        for r in self.hs.config.auto_join_rooms:
            try:
+                if auto_create_rooms and RoomAlias.is_valid(r):
+                    room_creation_handler = self.hs.get_room_creation_handler()


I know it's the only place it's used, but we prefer to get the handlers in the constructors where possible, so that we detect problems earlier.

richvdh · 2018-10-17T08:32:43Z

synapse/handlers/register.py

@@ -26,6 +26,7 @@
    RegistrationError,
    SynapseError,
 )
+from synapse.config._base import ConfigError


can you import this from synapse.config rather than the private _base module, please? (not that it's really appropriate to be raising ConfigErrors at runtime imho)

richvdh · 2018-10-17T08:34:05Z

synapse/handlers/register.py

                    room_creation_handler = self.hs.get_room_creation_handler()
+                    if self.hs.hostname != RoomAlias.from_string(r).domain:
+                        raise ConfigError(


... and if we can't check it during startup, it's probably more appropriate to warn and move on than to 500 reject the whole registration.

richvdh · 2018-10-17T08:34:16Z

synapse/handlers/register.py

                    room_creation_handler = self.hs.get_room_creation_handler()
+                    if self.hs.hostname != RoomAlias.from_string(r).domain:
+                        raise ConfigError(
+                            'Cannot create room alias %s, it does not match server domain'


this is missing its argument too.

richvdh · 2018-10-17T08:35:57Z

tests/handlers/test_register.py

+    def test_auto_create_auto_join_where_room_is_another_domain(self):
+        self.hs.config.auto_join_rooms = ["#room:another"]
+        frank = UserID.from_string("@frank:test")
+        res = yield self.handler.register(frank.localpart)


erm, why does this not throw an exception?

bare except in the try statement
Have since removed the exception as per comments above

richvdh · 2018-10-23T15:17:37Z

changelog.d/3975.feature

@@ -1 +1 @@
-Servers with auto join rooms, should autocreate those rooms when first user registers
+Servers with auto-join rooms, should automatically create those rooms when first user registers


Still some problems here:

s/, should/will now/

s/first user/the first user/

richvdh · 2018-10-23T15:18:28Z

synapse/config/registration.py

 from synapse.types import RoomAlias
 from synapse.util.stringutils import random_string_with_symbols

-from ._base import Config
+from ._base import Config, ConfigError


again, absolute imports are preferred over relative ones. Please s/._base/synapse.config._base/

right, misunderstood you

richvdh · 2018-10-23T15:20:51Z

synapse/handlers/register.py

+                            'Cannot create room alias %s, '
+                            'it does not match server domain' % (r,)
+                        )
+                        raise SynapseError()


why are we raising an exception here (and why does it have no message, but that's a side-issue)

this is brain dead, sorry

richvdh · 2018-10-23T15:21:36Z

synapse/handlers/register.py

                    if self.hs.hostname != RoomAlias.from_string(r).domain:
-                        raise ConfigError(
-                            'Cannot create room alias %s, it does not match server domain'
+                        logger.warn(


fwiw (just a nit fyi): logger.warn is deprecated, prefer logger.warning

richvdh · 2018-10-23T15:22:59Z

synapse/handlers/register.py

-                            'Cannot create room alias %s, it does not match server domain'
+                        logger.warn(
+                            'Cannot create room alias %s, '
+                            'it does not match server domain' % (r,)


the logger methods automatically interpolate their arguments (with the benefit of doing it after checking if logging is enabled), so, you can write:

logger.warn('message with %s', r)

rather than using % explicitly

richvdh · 2018-10-23T15:24:11Z

synapse/handlers/register.py

@@ -231,21 +231,23 @@ def register(
        for r in self.hs.config.auto_join_rooms:
            try:
                if should_auto_create_rooms:
-                    room_creation_handler = self.hs.get_room_creation_handler()
                    if self.hs.hostname != RoomAlias.from_string(r).domain:


might be nice to do RoomAlias.from_string(r) once and use a local var, rather than twice

richvdh

lgtm other than the nits below. Also your CI is failing.

changelog.d/3975.feature

synapse/handlers/register.py

Co-Authored-By: neilisfragile <[email protected]>

…autocreate_autojoin

ara4n added 4 commits September 28, 2018 01:42

untested stab at autocreating autojoin rooms

07340cd

fix UTs

8f646f2

fix thinkos

5b68f29

emit room aliases event

23b6a05

ara4n changed the title ~~WIP: autocreate autojoin rooms~~ Autocreate autojoin rooms Sep 29, 2018

changelog

faa462e

ara4n requested a review from a team September 29, 2018 01:21

richvdh previously requested changes Oct 1, 2018

View reviewed changes

richvdh assigned ara4n Oct 1, 2018

richvdh unassigned ara4n Oct 2, 2018

neilisfragile self-assigned this Oct 3, 2018

neilisfragile added 2 commits October 4, 2018 17:00

move logic into register, fix room alias localpart bug, tests

2dadc09

Merge branch 'develop' into matthew/autocreate_autojoin

ed82043

neilisfragile assigned richvdh Oct 4, 2018

richvdh self-requested a review October 10, 2018 06:20

richvdh suggested changes Oct 10, 2018

View reviewed changes

richvdh removed their assignment Oct 10, 2018

improve auto room join logic, comments and tests

a2bfb77

richvdh self-requested a review October 17, 2018 08:18

richvdh suggested changes Oct 17, 2018

View reviewed changes

richvdh assigned neilisfragile and unassigned richvdh Oct 17, 2018

clean up config error logic and imports

c6584f4

neilisfragile self-requested a review October 19, 2018 09:58

neilisfragile assigned richvdh and unassigned neilisfragile Oct 19, 2018

neilisfragile requested review from richvdh and a team and removed request for richvdh October 19, 2018 10:11

richvdh suggested changes Oct 23, 2018

View reviewed changes

richvdh assigned neilisfragile and unassigned richvdh Oct 23, 2018

remove errant exception and style

a67d8ac

neilisfragile assigned richvdh and unassigned neilisfragile Oct 23, 2018

neilisfragile requested a review from a team October 23, 2018 16:46

richvdh approved these changes Oct 23, 2018

View reviewed changes

changelog.d/3975.feature Outdated Show resolved Hide resolved

synapse/handlers/register.py Outdated Show resolved Hide resolved

richvdh assigned neilisfragile and unassigned richvdh Oct 23, 2018

richvdh and others added 5 commits October 24, 2018 14:37

Update changelog.d/3975.feature

9f72c20

Co-Authored-By: neilisfragile <[email protected]>

fix tuple

94a49e0

Co-Authored-By: neilisfragile <[email protected]>

remove trailing whiter space

9532caf

isort

9ec2186

Merge branch 'develop' of github.com:matrix-org/synapse into matthew/…

f7f487e

…autocreate_autojoin

neilisfragile merged commit c99b6c6 into develop Oct 25, 2018

neilisfragile deleted the matthew/autocreate_autojoin branch October 25, 2018 14:00

		@@ -513,6 +531,7 @@ def get_or_register_3pid_guest(self, medium, address, inviter_user_id):

		@defer.inlineCallbacks
		def _join_user_to_room(self, requester, room_identifier):

		@@ -1 +1 @@
		First user should autocreate autojoin rooms
		Servers with auto join rooms, should autocreate those rooms when first user registers

		@@ -1 +1 @@
		Servers with auto join rooms, should autocreate those rooms when first user registers
		Servers with auto-join rooms, should automatically create those rooms when first user registers

Autocreate autojoin rooms #3975

Autocreate autojoin rooms #3975

Conversation

ara4n commented Sep 28, 2018 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

richvdh Oct 1, 2018 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

richvdh commented Oct 1, 2018

ara4n commented Oct 1, 2018

maxidorius commented Oct 1, 2018

ara4n commented Oct 1, 2018

neilisfragile commented Oct 3, 2018

neilisfragile commented Oct 5, 2018

turt2live commented Oct 5, 2018

neilisfragile commented Oct 6, 2018

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

martindale commented Oct 12, 2018

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

richvdh left a comment

Choose a reason for hiding this comment

ara4n commented Sep 28, 2018 •

edited

Loading

richvdh Oct 1, 2018 •

edited

Loading