Merge pull request #11305 from Ostap-Zherebetskyi/fix/file_event_notifications

[ENG-8861] File Operations: Email content and subject not correct when file is renamed

Author: Johnetordoff

addons/base/views.py

@@ -619,10 +619,12 @@ def create_waterbutler_log(payload, **kwargs):
 
 @file_signals.file_updated.connect
 def emit_notification(self, target, user, payload, *args, **kwargs):
+    if not isinstance(target, Preprint):
+        return
     notification_types = {
         'rename': NotificationType.Type.ADDON_FILE_RENAMED.instance,
         'copy': NotificationType.Type.ADDON_FILE_COPIED.instance,
-        'create': NotificationType.Type.FILE_UPDATED.instance,
+        'create': NotificationType.Type.FILE_ADDED.instance,
         'move': NotificationType.Type.ADDON_FILE_MOVED.instance,
         'delete': NotificationType.Type.FILE_REMOVED.instance,
         'update': NotificationType.Type.FILE_UPDATED.instance,

notifications/file_event_notifications.py

@@ -261,6 +261,27 @@ def source_url(self):
 
 @register(NodeLog.FILE_RENAMED)
 class AddonFileRenamed(ComplexFileEvent):
+    def perform(self):
+        '''
+        Currently, WB sends the "move" action for renamed files.
+        This code will remain useless until the correct action is sent.
+        '''
+        if self.node == self.source_node:
+            super().perform()
+            return
+
+        NotificationType.Type.ADDON_FILE_RENAMED.instance.emit(
+            user=self.user,
+            event_context={
+                'user_fullname': self.user.fullname,
+                'message': self.html_message,
+                'profile_image_url': self.profile_image_url,
+                'localized_timestamp': self.timestamp,
+                'url': self.url,
+            },
+            is_digest=True,
+        )
+
     @property
     def html_message(self):
         return 'renamed {kind} "<b>{source_name}</b>" to "<b>{destination_name}</b>".'.format(
@@ -306,7 +327,7 @@ def perform(self):
             super().perform()
             return
 
-        NotificationType.Type.ADDON_FILE_MOVED.instance.emit(
+        NotificationType.Type.ADDON_FILE_COPIED.instance.emit(
             user=self.user,
             event_context={
                 'user_fullname': self.user.fullname,

tests/test_preprints.py

@@ -2244,13 +2244,14 @@ def test_action_file_rename(self):
                 'kind': 'file',
             },
         )
-        with capture_notifications():
+        with capture_notifications() as notifications:
             self.app.put(
                 url,
                 json=payload,
             )
         self.preprint.reload()
-
+        assert len(notifications['emits']) == 1
+        assert notifications['emits'][0]['type'] == NotificationType.Type.ADDON_FILE_RENAMED
         assert self.preprint.logs.latest().action == 'osf_storage_addon_file_renamed'
 
     def test_action_downloads_contrib(self):
@@ -2278,9 +2279,11 @@ def test_add_file_osfstorage_log(self):
         url = self.preprint.api_url_for('create_waterbutler_log')
         payload = self.build_payload(metadata={'nid': self.preprint._id, 'materialized': path, 'kind': 'file', 'path': path})
         nlogs = self.preprint.logs.count()
-        with capture_notifications():
+        with capture_notifications() as notifications:
             self.app.put(url, json=payload)
         self.preprint.reload()
+        assert len(notifications['emits']) == 1
+        assert notifications['emits'][0]['type'] == NotificationType.Type.FILE_ADDED
         assert self.preprint.logs.count() == nlogs + 1
         assert ('urls' in self.preprint.logs.filter(action='osf_storage_file_added')[0].params)
 
@@ -2289,9 +2292,11 @@ def test_add_folder_osfstorage_log(self):
         url = self.preprint.api_url_for('create_waterbutler_log')
         payload = self.build_payload(metadata={'nid': self.preprint._id, 'materialized': path, 'kind': 'folder', 'path': path})
         nlogs = self.preprint.logs.count()
-        with capture_notifications():
+        with capture_notifications() as notifications:
             self.app.put(url, json=payload)
         self.preprint.reload()
+        assert len(notifications['emits']) == 1
+        assert notifications['emits'][0]['type'] == NotificationType.Type.FILE_ADDED
         assert self.preprint.logs.count() == nlogs + 1
         assert ('urls' not in self.preprint.logs.filter(action='osf_storage_file_added')[0].params)