fix unit tests

Author: Ostap-Zherebetskyi

api/institutions/authentication.py

@@ -20,10 +20,10 @@
 
 from osf import features
 from osf.exceptions import InstitutionAffiliationStateError
-from osf.models import Institution
+from osf.models import Institution, NotificationType
 from osf.models.institution import SsoFilterCriteriaAction
 
-from website.mails import send_mail, WELCOME_OSF4I, DUPLICATE_ACCOUNTS_OSF4I, ADD_SSO_EMAIL_OSF4I
+from website.mails import send_mail, DUPLICATE_ACCOUNTS_OSF4I, ADD_SSO_EMAIL_OSF4I
 from website.settings import OSF_SUPPORT_EMAIL, DOMAIN
 from website.util.metrics import institution_source_tag
 
@@ -334,14 +334,13 @@ def authenticate(self, request):
             user.save()
 
             # Send confirmation email for all three: created, confirmed and claimed
-            send_mail(
-                to_addr=user.username,
-                mail=WELCOME_OSF4I,
-                user=user,
-                domain=DOMAIN,
-                osf_support_email=OSF_SUPPORT_EMAIL,
-                storage_flag_is_active=flag_is_active(request, features.STORAGE_I18N),
-            )
+            notification_type = NotificationType.objects.filter(name='welcome_osf4i')
+            if not notification_type.exists():
+                raise NotificationType.DoesNotExist(
+                    'NotificationType with name welcome_osf4i does not exist.',
+                )
+            notification_type = notification_type.first()
+            notification_type.emit(user=user, message_frequency='instantly', event_context={'domain': DOMAIN, 'osf_support_email': OSF_SUPPORT_EMAIL, 'storage_flag_is_active': flag_is_active(request, features.STORAGE_I18N)})
 
         # Add the email to the user's account if it is identified by the eppn
         if email_to_add:

api/users/views.py

@@ -99,7 +99,7 @@
     OSFUser,
     Email,
     Tag,
-    NotificationType
+    NotificationType,
 )
 from osf.utils.tokens import TokenHandler
 from osf.utils.tokens.handlers import sanction_handler
@@ -847,10 +847,10 @@ def get(self, request, *args, **kwargs):
                 notification_type = NotificationType.objects.filter(name=mail_template)
                 if not notification_type.exists():
                     raise NotificationType.DoesNotExist(
-                        f'NotificationType with name {mail_template} does not exist.'
+                        f'NotificationType with name {mail_template} does not exist.',
                     )
                 notification_type = notification_type.first()
-                notification_type.emit(user=user_obj, event_context={'can_change_preferences': False, 'reset_link': reset_link})
+                notification_type.emit(user=user_obj, message_frequency='instantly', event_context={'can_change_preferences': False, 'reset_link': reset_link})
 
         return Response(status=status.HTTP_200_OK, data={'message': status_message, 'kind': kind, 'institutional': institutional})
 
@@ -1066,10 +1066,10 @@ def _process_external_identity(self, user, external_identity, service_url):
             notification_type = NotificationType.objects.filter(name='external_confirm_success')
             if not notification_type.exists():
                 raise NotificationType.DoesNotExist(
-                    'NotificationType with name external_confirm_success does not exist.'
+                    'NotificationType with name external_confirm_success does not exist.',
                 )
             notification_type = notification_type.first()
-            notification_type.emit(user=user, event_context={'can_change_preferences': False, 'external_id_provider': provider})
+            notification_type.emit(user=user, message_frequency='instantly', event_context={'can_change_preferences': False, 'external_id_provider': provider})
 
         enqueue_task(update_affiliation_for_orcid_sso_users.s(user._id, provider_id))
 
@@ -1387,10 +1387,10 @@ def post(self, request, *args, **kwargs):
             notification_type = NotificationType.objects.filter(name='external_confirm_success')
             if not notification_type.exists():
                 raise NotificationType.DoesNotExist(
-                    'NotificationType with name external_confirm_success does not exist.'
+                    'NotificationType with name external_confirm_success does not exist.',
                 )
             notification_type = notification_type.first()
-            notification_type.emit(user=user, event_context={'can_change_preferences': False, 'external_id_provider': provider})
+            notification_type.emit(user=user, message_frequency='instantly', event_context={'can_change_preferences': False, 'external_id_provider': provider})
 
         enqueue_task(update_affiliation_for_orcid_sso_users.s(user._id, provider_id))
 

conftest.py

@@ -18,6 +18,7 @@
 from framework.celery_tasks import app as celery_app
 from osf.external.spam import tasks as spam_tasks
 from website import settings as website_settings
+from osf.management.commands.migrate_notifications import update_notification_types
 
 
 logger = logging.getLogger(__name__)
@@ -374,3 +375,25 @@ def start_mock_send_grid(test_case):
     test_case.addCleanup(patcher.stop)
     mocked_send.return_value = True
     return mocked_send
+
+
+@pytest.fixture()
+def mock_notification_send():
+    with mock.patch.object(website_settings, 'USE_EMAIL', True):
+        with mock.patch.object(website_settings, 'USE_CELERY', False):
+            with mock.patch('osf.models.notification.Notification.send') as mock_emit:
+                mock_emit.return_value = None  # Or True, if needed
+                yield mock_emit
+
+
+def start_mock_notification_send(test_case):
+    patcher = mock.patch('osf.models.notification.Notification.send')
+    mocked_emit = patcher.start()
+    test_case.addCleanup(patcher.stop)
+    mocked_emit.return_value = None
+    return mocked_emit
+
+
+@pytest.fixture(autouse=True)
+def load_notification_types(db, *args, **kwargs):
+    update_notification_types(*args, **kwargs)

framework/auth/views.py

@@ -33,7 +33,7 @@
 from osf.exceptions import ValidationValueError, BlockedEmailError
 from osf.models.provider import PreprintProvider
 from osf.models.tag import Tag
-from osf.models.notification import NotificationType
+from osf.models.notification_type import NotificationType
 from osf.utils.requests import check_select_for_update
 from website.util.metrics import CampaignClaimedTags, CampaignSourceTags
 from website.ember_osf_web.decorators import ember_flag_is_active
@@ -279,7 +279,7 @@ def _forgot_password_post(mail_template, reset_route, institutional=False):
                         f'NotificationType with name {mail_template} does not exist.'
                     )
                 notification_type = notification_type.first()
-                notification_type.emit(user=user_obj, event_context={'can_change_preferences': False, 'reset_link': reset_link})
+                notification_type.emit(user=user_obj, message_frequency='instantly', event_context={'can_change_preferences': False, 'reset_link': reset_link})
 
         # institutional forgot password page displays the message as main text, not as an alert
         if institutional:

notifications.yaml

@@ -14,6 +14,57 @@ notification_types:
     object_content_type_model_name: osfuser
     template: 'website/templates/emails/new_pending_submissions.html.mako'
     notification_freq_default: instantly
+  - name: password_reset
+    __docs__: ...
+    object_content_type_model_name: osfuser
+    template: 'website/templates/emails/password_reset.html.mako'
+    notification_freq_default: instantly
+  - name: forgot_password
+    __docs__: ...
+    object_content_type_model_name: osfuser
+    template: 'website/templates/emails/forgot_password.html.mako'
+    notification_freq_default: instantly
+  - name: welcome_osf4i
+    __docs__: ...
+    object_content_type_model_name: osfuser
+    template: 'website/templates/emails/welcome_osf4i.html.mako'
+    notification_freq_default: instantly
+  - name: invite_preprints_osf
+    __docs__: ...
+    object_content_type_model_name: osfuser
+    template: 'website/templates/emails/invite_preprints_osf.html.mako'
+    notification_freq_default: instantly
+  - name: invite_preprints
+    __docs__: ...
+    object_content_type_model_name: osfuser
+    template: 'website/templates/emails/invite_preprints.html.mako'
+    notification_freq_default: instantly
+  - name: invite_draft_registration
+    __docs__: ...
+    object_content_type_model_name: osfuser
+    template: 'website/templates/emails/invite_draft_registration.html.mako'
+    notification_freq_default: instantly
+  - name: invite_default
+    __docs__: ...
+    object_content_type_model_name: osfuser
+    template: 'website/templates/emails/invite_default.html.mako'
+    notification_freq_default: instantly
+  - name: pending_invite
+    __docs__: ...
+    object_content_type_model_name: osfuser
+    template: 'website/templates/emails/pending_invite.html.mako'
+    notification_freq_default: instantly
+  - name: forward_invite
+    __docs__: ...
+    object_content_type_model_name: osfuser
+    template: 'website/templates/emails/forward_invite.html.mako'
+    notification_freq_default: instantly
+  - name: external_confirm_success
+    __docs__: ...
+    object_content_type_model_name: osfuser
+    template: 'website/templates/emails/external_confirm_success.html.mako'
+    notification_freq_default: instantly
+
   #### PROVIDER
   - name: new_pending_submissions
     __docs__: ...

osf/models/notification.py

@@ -17,6 +17,8 @@ class Notification(models.Model):
     created = models.DateTimeField(auto_now_add=True)
 
     def send(self, protocol_type='email', recipient=None):
+        if not settings.USE_EMAIL:
+            return
         if not protocol_type == 'email':
             raise NotImplementedError(f'Protocol type {protocol_type}. Email notifications are only implemented.')
 

osf/models/user.py

@@ -57,11 +57,12 @@
 from osf.utils.requests import check_select_for_update
 from osf.utils.permissions import API_CONTRIBUTOR_PERMISSIONS, MANAGER, MEMBER, ADMIN
 from website import settings as website_settings
-from website import filters, mails
+from website import filters
 from website.project import new_bookmark_collection
 from website.util.metrics import OsfSourceTags, unregistered_created_source_tag
 from importlib import import_module
 from osf.utils.requests import get_headers_from_request
+from osf.models.notification_type import NotificationType
 
 SessionStore = import_module(settings.SESSION_ENGINE).SessionStore
 
@@ -1071,13 +1072,13 @@ def set_password(self, raw_password, notify=True):
             raise ChangePasswordError(['Password cannot be the same as your email address'])
         super().set_password(raw_password)
         if had_existing_password and notify:
-            mails.send_mail(
-                to_addr=self.username,
-                mail=mails.PASSWORD_RESET,
-                user=self,
-                can_change_preferences=False,
-                osf_contact_email=website_settings.OSF_CONTACT_EMAIL
-            )
+            notification_type = NotificationType.objects.filter(name='password_reset')
+            if not notification_type.exists():
+                raise NotificationType.DoesNotExist(
+                    'NotificationType with name password_reset does not exist.',
+                )
+            notification_type = notification_type.first()
+            notification_type.emit(user=self, message_frequency='instantly', event_context={'can_change_preferences': False, 'osf_contact_email': website_settings.OSF_CONTACT_EMAIL})
             remove_sessions_for_user(self)
 
     @classmethod