Only sync and set active room after user has joined room.

[fancycode]

This fixes a race condition when (as logged in user) joining a public room that has been created by another user. It can happen that the list of rooms is fetched before the "join room" request finished, so the room is not included in the list, causing syncAndSetActiveRoom (https://github.com/nextcloud/spreed/blob/master/js/app.js#L324) to fail.

As a solution, syncAndSetActiveRoom is only called when the room was joined to make sure it is included in the list of rooms.

[danxuliu]

This breaks the UI in the public share authentication page (the video verification).

Also, it may cause a race condition in the Files app, although I am not sure about that; the acceptance tests fail there too, but it could be a false positive given that the previous test to the failed one shows several timeouts. However, I tested it manually and I had a similar (although not identical) problem once, but it could have been a cache issue too. So... I am not sure :-)

[danxuliu]

After checking again the issue I had with the Files app it seems to be unrelated to this pull request.

Regarding the breaking of the public share authentication page the reason is that, when this pull request was created, PublicShareAuth still used the Application class. Due to this, when syncAndSetActiveRoom() was called after joining the room a handler was set to update the contents when the participant flags changed, and when the participant joined the call the handler performed the same content update as when the full UI is used. In that case the chat view is detached and then attached again to the sidebar but with PublicShareAuth the sidebar object and the visible sidebar element were not connected, so the chat view was detached and never shown again. Note that the issue did not happen when syncAndSetActiveRoom() was called from Connection.joinRoom because that method is not called when PublicShareAuth is used.

Also note that after rebasing this pull request on current master the issue in the public share authentication page is gone, as PublicShareAuth now uses Embedded instead of Application and thus the chat is no longer detached when joining the call. Due to this, although the bug fixed by this pull request happens too in Talk 5 (and maybe even Talk 4, I have not checked) it can not be directly backported to stable15 or lower.

While checking all this I found that calling syncAndSetActiveRoom() is only needed when using the Application class, so I added some more commits to this pull request to clean up the code a bit.

As my approval now becomes a self-approval it would be good if someone else could check all this before merging ;-)

Besides the test described below, which triggers the original bug, it would be good to check that the Files app and the public share authentication page still work as expected ;-)

How to test

-Replace the call to this.app.signaling.joinRoom(token); with setTimeout(function() { this.app.signaling.joinRoom(token); }.bind(this), 5000); to delay joining the room*
-Create a public room with user A
-Join that public room with user B (without being invited, just copying and pasting the URL in the address bar)

*Adding a sleep to joinRoom at the start of the controller would not show the issue, because POST requests block further requests (at least, it does in my setup :-P ) so the room list would not be returned before joining the room, which is what made syncAndSetActiveRoom fail; the request to fetch the room list needs to be started before the request to join the room to trigger the bug.

Result with this pull request

The room is loaded.

Result without this pull request

The room is not loaded, although it appears in the navigation bar; the problem is in the main view.

[danxuliu]

/backport to stable16

[Ivansss]

Tested and works 👍

[backportbot-nextcloud]

backport to stable16 in #1914