add do_notify param to endpoints for roles

backend/tracim_backend/lib/core/userworkspace.py

@@ -115,7 +115,7 @@ class RoleApi(object):
         """
         role.role = role_level
         if with_notif is not None:
-            role.do_notify == with_notif
+            role.do_notify = with_notif
         if save_now:
             self.save(role)
 

backend/tracim_backend/models/context_models.py

@@ -262,8 +262,10 @@ class RoleUpdate(object):
     def __init__(
         self,
         role: str,
+        do_notify: bool,
     ):
         self.role = role
+        self.do_notify = do_notify
 
 
 class WorkspaceMemberInvitation(object):
@@ -275,10 +277,12 @@ class WorkspaceMemberInvitation(object):
         user_id: int,
         user_email_or_public_name: str,
         role: str,
+        do_notify: str,
     ):
         self.role = role
         self.user_email_or_public_name = user_email_or_public_name
         self.user_id = user_id
+        self.do_notify = do_notify
 
 
 class WorkspaceUpdate(object):
@@ -570,6 +574,10 @@ class UserRoleWorkspaceInContext(object):
         return self.user.is_active
 
     @property
+    def do_notify(self) -> bool:
+        return self.user_role.do_notify
+
+    @property
     def user(self) -> UserInContext:
         """
         User who has this role, with context data

backend/tracim_backend/tests/functional/test_workspaces.py

@@ -901,6 +901,7 @@ class TestWorkspaceMembersEndpoint(FunctionalTest):
         assert user_role['user']['public_name'] == 'Global manager'
         assert user_role['user']['user_id'] == 1
         assert user_role['is_active'] is True
+        assert user_role['do_notify'] is True
         # TODO - G.M - 24-05-2018 - [Avatar] Replace
         # by correct value when avatar feature will be enabled
         assert user_role['user']['avatar_url'] is None
@@ -975,6 +976,7 @@ class TestWorkspaceMembersEndpoint(FunctionalTest):
             'user_id': 2,
             'user_email_or_public_name': None,
             'role': 'content-manager',
+            'do_notify': False,
         }
         res = self.testapp.post_json(
             '/api/v2/workspaces/1/members',
@@ -987,6 +989,7 @@ class TestWorkspaceMembersEndpoint(FunctionalTest):
         assert user_role_found['workspace_id'] == 1
         assert user_role_found['newly_created'] is False
         assert user_role_found['email_sent'] is False
+        assert user_role_found['do_notify'] is False
 
         res = self.testapp.get('/api/v2/workspaces/1/members', status=200).json_body   # nopep8
         assert len(res) == 2
@@ -1016,6 +1019,7 @@ class TestWorkspaceMembersEndpoint(FunctionalTest):
             'user_id': None,
             'user_email_or_public_name': 'lawrence-not-real-email@fsf.local',
             'role': 'content-manager',
+            'do_notify': 'True',
         }
         res = self.testapp.post_json(
             '/api/v2/workspaces/1/members',
@@ -1028,6 +1032,7 @@ class TestWorkspaceMembersEndpoint(FunctionalTest):
         assert user_role_found['workspace_id'] == 1
         assert user_role_found['newly_created'] is False
         assert user_role_found['email_sent'] is False
+        assert user_role_found['do_notify'] is True
 
         res = self.testapp.get('/api/v2/workspaces/1/members', status=200).json_body   # nopep8
         assert len(res) == 2
@@ -1057,6 +1062,7 @@ class TestWorkspaceMembersEndpoint(FunctionalTest):
             'user_id': None,
             'user_email_or_public_name': 'Lawrence L.',
             'role': 'content-manager',
+            'do_notify': True,
         }
         res = self.testapp.post_json(
             '/api/v2/workspaces/1/members',
@@ -1069,6 +1075,7 @@ class TestWorkspaceMembersEndpoint(FunctionalTest):
         assert user_role_found['workspace_id'] == 1
         assert user_role_found['newly_created'] is False
         assert user_role_found['email_sent'] is False
+        assert user_role_found['do_notify'] is True
 
         res = self.testapp.get('/api/v2/workspaces/1/members', status=200).json_body   # nopep8
         assert len(res) == 2
@@ -1098,6 +1105,7 @@ class TestWorkspaceMembersEndpoint(FunctionalTest):
             'user_id': None,
             'user_email_or_public_name': None,
             'role': 'content-manager',
+            'do_notify': True,
         }
         res = self.testapp.post_json(
             '/api/v2/workspaces/1/members',
@@ -1122,6 +1130,7 @@ class TestWorkspaceMembersEndpoint(FunctionalTest):
             'user_id': 47,
             'user_email_or_public_name': None,
             'role': 'content-manager',
+            'do_notify': True,
         }
         res = self.testapp.post_json(
             '/api/v2/workspaces/1/members',
@@ -1146,6 +1155,7 @@ class TestWorkspaceMembersEndpoint(FunctionalTest):
             'user_id': None,
             'user_email_or_public_name': 'nothing@nothing.nothing',
             'role': 'content-manager',
+            'do_notify': True,
         }
         res = self.testapp.post_json(
             '/api/v2/workspaces/1/members',
@@ -1159,6 +1169,7 @@ class TestWorkspaceMembersEndpoint(FunctionalTest):
         assert user_role_found['workspace_id'] == 1
         assert user_role_found['newly_created'] is True
         assert user_role_found['email_sent'] is False
+        assert user_role_found['do_notify'] is True
 
         res = self.testapp.get('/api/v2/workspaces/1/members',
                                status=200).json_body  # nopep8
@@ -1193,6 +1204,7 @@ class TestWorkspaceMembersEndpoint(FunctionalTest):
         # update workspace role
         params = {
             'role': 'content-manager',
+            'do_notify': False,
         }
         res = self.testapp.put_json(
             '/api/v2/workspaces/1/members/1',
@@ -1208,6 +1220,7 @@ class TestWorkspaceMembersEndpoint(FunctionalTest):
         assert len(res) == 1
         user_role = res[0]
         assert user_role['role'] == 'content-manager'
+        assert user_role['do_notify'] is False
         assert user_role['user_id'] == 1
         assert user_role['workspace_id'] == 1
 
@@ -1350,6 +1363,7 @@ class TestUserInvitationWithMailActivatedSync(FunctionalTest):
             'user_id': None,
             'user_email_or_public_name': 'bob@bob.bob',
             'role': 'content-manager',
+            'do_notify': True,
         }
         res = self.testapp.post_json(
             '/api/v2/workspaces/1/members',
@@ -1363,6 +1377,7 @@ class TestUserInvitationWithMailActivatedSync(FunctionalTest):
         assert user_role_found['workspace_id'] == 1
         assert user_role_found['newly_created'] is True
         assert user_role_found['email_sent'] is True
+        assert user_role_found['do_notify'] is True
 
         # check mail received
         response = requests.get('http://127.0.0.1:8025/api/v1/messages')
@@ -1399,6 +1414,7 @@ class TestUserInvitationWithMailActivatedASync(FunctionalTest):
             'user_id': None,
             'user_email_or_public_name': 'bob@bob.bob',
             'role': 'content-manager',
+            'do_notify': True,
         }
         res = self.testapp.post_json(
             '/api/v2/workspaces/1/members',

backend/tracim_backend/views/core_api/schemas.py

@@ -437,6 +437,12 @@ class RoleUpdateSchema(marshmallow.Schema):
         example='contributor',
         validate=OneOf(UserRoleInWorkspace.get_all_role_slug())
     )
+    do_notify = marshmallow.fields.Bool(
+        description='has user enabled notification for this workspace',
+        example=True,
+        default=None,
+        allow_none=True,
+    )
 
     @post_load
     def make_role(self, data):
@@ -575,6 +581,10 @@ class WorkspaceMemberSchema(marshmallow.Schema):
         WorkspaceDigestSchema(exclude=('sidebar_entries',))
     )
     is_active = marshmallow.fields.Bool()
+    do_notify = marshmallow.fields.Bool(
+        description='has user enabled notification for this workspace',
+        example=True,
+    )
 
     class Meta:
         description = 'Workspace Member information'

backend/tracim_backend/views/core_api/workspace_controller.py

@@ -221,7 +221,8 @@ class WorkspaceController(Controller):
         workspace_role = WorkspaceRoles.get_role_from_slug(hapic_data.body.role)
         role = rapi.update_role(
             role,
-            role_level=workspace_role.level
+            role_level=workspace_role.level,
+            with_notif=hapic_data.body.do_notify
         )
         return rapi.get_user_role_workspace_with_context(role)
 
@@ -302,7 +303,7 @@ class WorkspaceController(Controller):
             user=user,
             workspace=request.current_workspace,
             role_level=WorkspaceRoles.get_role_from_slug(hapic_data.body.role).level,  # nopep8
-            with_notif=False,
+            with_notif=hapic_data.body.do_notify or False,  # nopep8, default value as false
             flush=True,
         )
         return rapi.get_user_role_workspace_with_context(