Skip to content

[ENG-8868] File Operation: No notifications sent when file upload failed #11295

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 2 commits into from
Sep 12, 2025
Merged

[ENG-8868] File Operation: No notifications sent when file upload failed #11295

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
bbb899b
fix file action emails
Ostap-Zherebetskyi Sep 12, 2025
7fb32f1
add unit tests
Ostap-Zherebetskyi Sep 12, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
12 changes: 9 additions & 3 deletions addons/base/views.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -584,12 +584,18 @@ def create_waterbutler_log(payload, **kwargs):
event_context={
'user_fullname': user.fullname,
'action': payload['action'],
'source_node': source_node,
'destination_node': destination_node,
'source_node': source_node._id,
'source_node_title': source_node.title,
'destination_node': destination_node._id,
'destination_node_title': destination_node.title,
'destination_node_parent_node_title': destination_node.parent_node.title if destination_node.parent_node else None,
'source_path': payload['source']['materialized'],
'source_addon': payload['source']['addon'],
'destination_addon': payload['destination']['addon'],
'osf_support_email': settings.OSF_SUPPORT_EMAIL
'osf_support_email': settings.OSF_SUPPORT_EMAIL,
'logo': settings.OSF_LOGO,
'OSF_LOGO_LIST': settings.OSF_LOGO_LIST,
'OSF_LOGO': settings.OSF_LOGO,
}
)
if payload.get('errors'):
Expand Down
165 changes: 165 additions & 0 deletions api_tests/mailhog/test_create_wb_log.py
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,165 @@
import time
import pytest
from framework.auth import signing
from waffle.testutils import override_switch
from osf import features
from osf_tests.factories import (
AuthUserFactory,
NodeFactory
)
from tests.base import (
OsfTestCase,
)
from tests.utils import get_mailhog_messages, delete_mailhog_messages, assert_emails
from importlib import import_module

from django.conf import settings as django_conf_settings
import itsdangerous
from framework.auth.core import Auth
from addons.osfstorage.models import OsfStorageFile
from tests.utils import capture_notifications
from website import settings

SessionStore = import_module(django_conf_settings.SESSION_ENGINE).SessionStore

pytestmark = pytest.mark.django_db


class TestCreateWBLog(OsfTestCase):

def setUp(self):
super().setUp()
self.user = AuthUserFactory()
self.user_non_contrib = AuthUserFactory()
self.auth_obj = Auth(user=self.user)
self.node = NodeFactory(creator=self.user)
self.file = OsfStorageFile.create(
target=self.node,
path='/testfile',
_id='testfile',
name='testfile',
materialized_path='/testfile'
)
self.file.save()
self.session = SessionStore()
self.session['auth_user_id'] = self.user._id
self.session.create()
self.cookie = itsdangerous.Signer(settings.SECRET_KEY).sign(self.session.session_key)

self.source_dest = {
'source': {
'nid': self.node._id,
'resource': self.node._id,
'provider': 'osfstorage',
'kind': 'file',
'path': '/68c416d5993abb955649e39b',
'name': 'file.png',
'materialized': '/file.png',
'extra': {}
},
'destination': {
'nid': self.node._id,
'resource': self.node._id,
'extra': {
'guid': None,
'version': 1,
'downloads': 0,
'checkout': None,
'latestVersionSeen': None,
'hashes': {
'md5': '4df1cc7556a50f437318bed256795b99',
'sha256': 'd22324aa85762f3eeec36987b99a4e23067b492d8296ef246bb5d3eac0c21842'
}
},
'kind': 'file',
'name': 'file.png',
'path': '/68c416d5993abb955649e39b',
'provider': 'osfstorage',
'materialized': '/file.png',
'etag': '568e49bea15354e35105a828a1775351921f2be70dedfcb3482d56f574189b6e',
'contentType': None,
'modified': '2025-09-12T12:49:25.352543+00:00',
'modified_utc': '2025-09-12T12:49:25.352543+00:00',
'created_utc': '2025-09-12T12:49:25.352543+00:00',
'size': 208287,
'sizeInt': 208287
}
}

def build_payload(self, action, metadata, **kwargs):
options = dict(
auth={'id': self.user._id},
action=action,
provider='osfstorage',
metadata=metadata,
time=time.time() + 1000,
**self.source_dest
)
options.update(kwargs)
options = {
key: value
for key, value in options.items()
if value is not None
}
message, signature = signing.default_signer.sign_payload(options)
return {
'payload': message,
'signature': signature,
}

@override_switch(features.ENABLE_MAILHOG, active=True)
def test_log_move_file_error(self):
path = 'pizza'
url = self.node.api_url_for('create_waterbutler_log')
payload = self.build_payload(action='move', metadata={'nid': self.node._id, 'materialized': path, 'kind': 'file', 'path': path}, errors=['some error'])
delete_mailhog_messages()

with capture_notifications(passthrough=True) as notifications:
self.app.put(url, json=payload)

mailhog = get_mailhog_messages()
assert mailhog['count'] == len(notifications['emails'])
assert_emails(mailhog, notifications)

@override_switch(features.ENABLE_MAILHOG, active=True)
def test_log_copy_file_error(self):
path = 'pizza'
url = self.node.api_url_for('create_waterbutler_log')
payload = self.build_payload(action='copy', metadata={'nid': self.node._id, 'materialized': path, 'kind': 'file', 'path': path}, errors=['some error'])
delete_mailhog_messages()

with capture_notifications(passthrough=True) as notifications:
self.app.put(url, json=payload)
mailhog = get_mailhog_messages()
assert mailhog['count'] == len(notifications['emails'])
assert_emails(mailhog, notifications)

@override_switch(features.ENABLE_MAILHOG, active=True)
def test_log_move_file_success(self):
path = 'pizza'
url = self.node.api_url_for('create_waterbutler_log')
payload = self.build_payload(action='move', metadata={'nid': self.node._id, 'materialized': path, 'kind': 'file', 'path': path})
delete_mailhog_messages()

with capture_notifications(passthrough=True) as notifications:
self.app.put(url, json=payload)

mailhog = get_mailhog_messages()
assert mailhog['count'] == len(notifications['emails'])
messages = {'count': mailhog['count'], 'items': mailhog['items'][::-1]} # Reverse to get chronological order
assert_emails(messages, notifications)

@override_switch(features.ENABLE_MAILHOG, active=True)
def test_log_copy_file_success(self):
path = 'pizza'
url = self.node.api_url_for('create_waterbutler_log')
payload = self.build_payload(action='copy', metadata={'nid': self.node._id, 'materialized': path, 'kind': 'file', 'path': path})
delete_mailhog_messages()

with capture_notifications(passthrough=True) as notifications:
self.app.put(url, json=payload)

mailhog = get_mailhog_messages()
assert mailhog['count'] == len(notifications['emails'])
messages = {'count': mailhog['count'], 'items': mailhog['items'][::-1]} # Reverse to get chronological order
assert_emails(messages, notifications)
2 changes: 1 addition & 1 deletion website/templates/file_operation_failed.html.mako
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -46,7 +46,7 @@
<th colspan="2" style="padding: 0px 15px 0 15px">
<h3 style="padding: 0 15px 5px 15px; margin: 30px 0 0 0;border: none;list-style: none;font-weight: 300; border-bottom: 1px solid #eee; text-align: left;">
${destination_node_title}
%if destination_node.parent_node:
%if destination_node_parent_node_title:
<small style="font-size: 14px;color: #999;"> in ${destination_node_parent_node_title} </small>
%endif
</h3>
Expand Down
2 changes: 1 addition & 1 deletion website/templates/file_operation_success.html.mako
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -46,7 +46,7 @@
<th colspan="2" style="padding: 0px 15px 0 15px">
<h3 style="padding: 0 15px 5px 15px; margin: 30px 0 0 0;border: none;list-style: none;font-weight: 300; border-bottom: 1px solid #eee; text-align: left;">
${destination_node_title}
%if destination_node.parent_node:
%if destination_node_parent_node_title:
<small style="font-size: 14px;color: #999;"> in ${destination_node_parent_node_title} </small>
%endif
</h3>
Expand Down
Loading