Room info fixes

The actual data we were returning for rooms didn't quite match what is
in api.yaml, and was missing the room defaults info.

Changes:

- Don't include `'moderator': True` unless we are a moderator
- Don't include `'admin': True` unless we are an admin
- Don't include room description when it is null
- Add default_read/default_write/default_upload fields to room info if
  we have mod permissions so that a moderator client can see the current
  value.
- Fix tests for the above.

Author: jagerman

api.yaml

@@ -184,6 +184,12 @@ paths:
                     $ref: "#/components/schemas/Room/properties/global_moderator"
                   global_admin:
                     $ref: "#/components/schemas/Room/properties/global_admin"
+                  default_read:
+                    $ref: "#/components/schemas/Room/properties/default_read"
+                  default_write:
+                    $ref: "#/components/schemas/Room/properties/default_write"
+                  default_upload:
+                    $ref: "#/components/schemas/Room/properties/default_upload"
                   details:
                     allOf:
                       - $ref: "#/components/schemas/Room"
@@ -1526,6 +1532,26 @@ components:
             Whether the requesting user has permissions to upload attachments to messages posted to
             the room.  (Note that changes to this property do not cause an `info_update` increment.)
           example: true
+        default_read:
+          type: boolean
+          description: >
+            Whether new users have permission to read posts in this room by default.  This property
+            is only returned if the calling user has moderator/admin permissions.
+          example: true
+        default_write:
+          type: boolean
+          description: >
+            Whether new users have permission to write posts in this room by default.  This property
+            is only returned if the calling user has moderator/admin permissions.
+          example: true
+        default_upload:
+          type: boolean
+          description: >
+            Whether new users have permission to upload attachments to posts in this room by
+            default.  This property is only returned if the calling user has moderator/admin
+            permissions.
+          example: true
+
     Message:
       title: The content of a posted message
       type: object
@@ -1637,9 +1663,6 @@ components:
       description: "Session ID of a user."
       schema:
         $ref: "#/components/schemas/SessionID"
-        
-
-
 
   securitySchemes:
     pubkey:

sogs/routes/rooms.py

@@ -18,21 +18,21 @@ def get_one_room(room):
     rr = {
         'token': room.token,
         'name': room.name,
-        'description': room.description,
         'info_updates': room.info_updates,
         'message_sequence': room.message_sequence,
         'created': room.created,
         'active_users': room.active_users(),
         'active_users_cutoff': int(config.ROOM_DEFAULT_ACTIVE_THRESHOLD * 86400),
         'moderators': mods,
         'admins': admins,
-        'moderator': room.check_moderator(g.user),
-        'admin': room.check_admin(g.user),
         'read': room.check_read(g.user),
         'write': room.check_write(g.user),
         'upload': room.check_upload(g.user),
     }
 
+    if room.description is not None:
+        rr['description'] = room.description
+
     if room.image_id is not None:
         rr['image_id'] = room.image_id
 
@@ -45,6 +45,13 @@ def get_one_room(room):
     if h_admins:
         rr['hidden_admins'] = h_admins
 
+    if room.check_moderator(g.user):
+        rr['moderator'] = True
+        rr['default_read'] = room.default_read
+        rr['default_write'] = room.default_write
+        rr['default_upload'] = room.default_upload
+    if room.check_admin(g.user):
+        rr['admin'] = True
     if g.user:
         if g.user.global_moderator:
             rr['global_moderator'] = True
@@ -126,8 +133,6 @@ def poll_room_info(room, info_updated):
     result = {
         'token': room.token,
         'active_users': room.active_users(),
-        'moderator': room.check_moderator(g.user),
-        'admin': room.check_admin(g.user),
         'read': room.check_read(g.user),
         'write': room.check_write(g.user),
         'upload': room.check_upload(g.user),
@@ -136,6 +141,13 @@ def poll_room_info(room, info_updated):
     if room.info_updates != info_updated:
         result['details'] = get_one_room(room)
 
+    if room.check_moderator(g.user):
+        result['moderator'] = True
+        result['default_read'] = room.default_read
+        result['default_write'] = room.default_write
+        result['default_upload'] = room.default_upload
+    if room.check_admin(g.user):
+        result['admin'] = True
     if g.user:
         if g.user.global_moderator:
             result['global_moderator'] = True

tests/test_room_routes.py

@@ -31,12 +31,11 @@ def test_list(client, room, user, user2, admin, mod, global_mod, global_admin):
         "active_users_cutoff": int(86400 * sogs.config.ROOM_DEFAULT_ACTIVE_THRESHOLD),
         "moderators": [],
         "admins": [],
-        "moderator": False,
-        "admin": False,
         "read": True,
         "write": False,
         "upload": False,
     }
+    r2_exp_defs = {"default_read": True, "default_write": False, "default_upload": False}
     r_expected = {
         "token": "test-room",
         "name": "Test room",
@@ -48,12 +47,11 @@ def test_list(client, room, user, user2, admin, mod, global_mod, global_admin):
         "active_users_cutoff": int(86400 * sogs.config.ROOM_DEFAULT_ACTIVE_THRESHOLD),
         "moderators": [mod.session_id],
         "admins": [admin.session_id],
-        "moderator": False,
-        "admin": False,
         "read": True,
         "write": True,
         "upload": True,
     }
+    r_exp_defs = {"default_read": True, "default_write": True, "default_upload": True}
     r3_expected = {
         "token": "room3",
         "name": "Room 3",
@@ -65,12 +63,11 @@ def test_list(client, room, user, user2, admin, mod, global_mod, global_admin):
         "active_users_cutoff": int(86400 * sogs.config.ROOM_DEFAULT_ACTIVE_THRESHOLD),
         "moderators": [],
         "admins": [],
-        "moderator": False,
-        "admin": False,
         "read": True,
         "write": False,
         "upload": False,
     }
+    r3_exp_defs = {"default_read": False, "default_write": False, "default_upload": False}
 
     exp_mod = {
         **{p: True for p in ("moderator", "read", "write", "upload")},
@@ -99,26 +96,26 @@ def test_list(client, room, user, user2, admin, mod, global_mod, global_admin):
 
     r = sogs_get(client, "/rooms", mod)
     assert r.status_code == 200
-    assert r.json == [r2_expected, {**r_expected, **exp_mod}]
+    assert r.json == [r2_expected, {**r_expected, **r_exp_defs, **exp_mod}]
 
     r = sogs_get(client, "/rooms", admin)
     assert r.status_code == 200
-    assert r.json == [r2_expected, {**r_expected, **exp_admin}]
+    assert r.json == [r2_expected, {**r_expected, **r_exp_defs, **exp_admin}]
 
     r = sogs_get(client, "/rooms", global_mod)
     assert r.status_code == 200
     assert r.json == [
-        {**r2_expected, **exp_gmod},
-        {**r3_expected, **exp_gmod},
-        {**r_expected, **exp_gmod},
+        {**r2_expected, **r2_exp_defs, **exp_gmod},
+        {**r3_expected, **r3_exp_defs, **exp_gmod},
+        {**r_expected, **r_exp_defs, **exp_gmod},
     ]
 
     r = sogs_get(client, "/rooms", global_admin)
     assert r.status_code == 200
     assert r.json == [
-        {**r2_expected, **exp_gadmin},
-        {**r3_expected, **exp_gadmin},
-        {**r_expected, **exp_gadmin},
+        {**r2_expected, **r2_exp_defs, **exp_gadmin},
+        {**r3_expected, **r3_exp_defs, **exp_gadmin},
+        {**r_expected, **r_exp_defs, **exp_gadmin},
     ]
 
     r = sogs_get(client, "/room/room3", user)
@@ -131,7 +128,7 @@ def test_list(client, room, user, user2, admin, mod, global_mod, global_admin):
 
     r = sogs_get(client, "/room/room3", global_admin)
     assert r.status_code == 200
-    assert r.json == {**r3_expected, **exp_gadmin}
+    assert r.json == {**r3_expected, **r3_exp_defs, **exp_gadmin}
 
 
 def test_updates(client, room, user, user2, mod, admin, global_mod, global_admin):
@@ -322,15 +319,7 @@ def test_polling(client, room, user, user2, mod, admin, global_mod, global_admin
     info_up = r.json['info_updates']
     assert info_up == 2
 
-    basic = {
-        'token': 'test-room',
-        'active_users': 1,
-        'moderator': False,
-        'admin': False,
-        'read': True,
-        'write': True,
-        'upload': True,
-    }
+    basic = {'token': 'test-room', 'active_users': 1, 'read': True, 'write': True, 'upload': True}
     details = {
         "token": "test-room",
         "name": "Test room",
@@ -342,12 +331,11 @@ def test_polling(client, room, user, user2, mod, admin, global_mod, global_admin
         "active_users_cutoff": int(86400 * sogs.config.ROOM_DEFAULT_ACTIVE_THRESHOLD),
         "moderators": [mod.session_id],
         "admins": [admin.session_id],
-        "moderator": False,
-        "admin": False,
         "read": True,
         "write": True,
         "upload": True,
     }
+    defs = {'default_' + x: True for x in ('read', 'write', 'upload')}
 
     r = sogs_get(client, f"/room/test-room/pollInfo/{info_up}", user)
     assert r.status_code == 200
@@ -368,13 +356,13 @@ def test_polling(client, room, user, user2, mod, admin, global_mod, global_admin
     basic['active_users'] += 1
     details['active_users'] += 1
     assert r.status_code == 200
-    assert r.json == {**basic, 'moderator': True}
+    assert r.json == {**basic, 'moderator': True, **defs}
 
     r = sogs_get(client, f"/room/test-room/pollInfo/{info_up}", admin)
     assert r.status_code == 200
     basic['active_users'] += 1
     details['active_users'] += 1
-    assert r.json == {**basic, 'moderator': True, 'admin': True}
+    assert r.json == {**basic, 'moderator': True, 'admin': True, **defs}
 
     # Changing description
     room.description = 'Test suite testing room new desc'
@@ -418,9 +406,11 @@ def test_polling(client, room, user, user2, mod, admin, global_mod, global_admin
     details['moderators'] = sorted(details['moderators'] + [user.session_id])
     assert r.json == {
         **basic,
+        **defs,
         'moderator': True,
         'details': {
             **details,
+            **defs,
             'moderator': True,
             'hidden_admins': [global_admin.session_id],
             'hidden_moderators': [global_mod.session_id],