add new data model for notifications

Author: Johnetordoff

admin/notifications/views.py

@@ -1,17 +1,17 @@
-from osf.models.notifications import NotificationSubscription
+from osf.models.notifications import NotificationSubscriptionLegacy
 from django.db.models import Count
 
 def delete_selected_notifications(selected_ids):
-    NotificationSubscription.objects.filter(id__in=selected_ids).delete()
+    NotificationSubscriptionLegacy.objects.filter(id__in=selected_ids).delete()
 
 def detect_duplicate_notifications(node_id=None):
-    query = NotificationSubscription.objects.values('_id').annotate(count=Count('_id')).filter(count__gt=1)
+    query = NotificationSubscriptionLegacy.objects.values('_id').annotate(count=Count('_id')).filter(count__gt=1)
     if node_id:
         query = query.filter(node_id=node_id)
 
     detailed_duplicates = []
     for dup in query:
-        notifications = NotificationSubscription.objects.filter(
+        notifications = NotificationSubscriptionLegacy.objects.filter(
             _id=dup['_id']
         ).order_by('created')
 

admin_tests/notifications/test_views.py

@@ -1,10 +1,11 @@
 import pytest
 from django.test import RequestFactory
-from osf.models import OSFUser, NotificationSubscription, Node
+from osf.models import OSFUser, Node
 from admin.notifications.views import (
     delete_selected_notifications,
     detect_duplicate_notifications,
 )
+from osf.models.notifications import NotificationSubscriptionLegacy
 from tests.base import AdminTestCase
 
 pytestmark = pytest.mark.django_db
@@ -18,19 +19,19 @@ def setUp(self):
         self.request_factory = RequestFactory()
 
     def test_delete_selected_notifications(self):
-        notification1 = NotificationSubscription.objects.create(user=self.user, node=self.node, event_name='event1')
-        notification2 = NotificationSubscription.objects.create(user=self.user, node=self.node, event_name='event2')
-        notification3 = NotificationSubscription.objects.create(user=self.user, node=self.node, event_name='event3')
+        notification1 = NotificationSubscriptionLegacy.objects.create(user=self.user, node=self.node, event_name='event1')
+        notification2 = NotificationSubscriptionLegacy.objects.create(user=self.user, node=self.node, event_name='event2')
+        notification3 = NotificationSubscriptionLegacy.objects.create(user=self.user, node=self.node, event_name='event3')
 
         delete_selected_notifications([notification1.id, notification2.id])
 
-        assert not NotificationSubscription.objects.filter(id__in=[notification1.id, notification2.id]).exists()
-        assert NotificationSubscription.objects.filter(id=notification3.id).exists()
+        assert not NotificationSubscriptionLegacy.objects.filter(id__in=[notification1.id, notification2.id]).exists()
+        assert NotificationSubscriptionLegacy.objects.filter(id=notification3.id).exists()
 
     def test_detect_duplicate_notifications(self):
-        NotificationSubscription.objects.create(user=self.user, node=self.node, event_name='event1')
-        NotificationSubscription.objects.create(user=self.user, node=self.node, event_name='event1')
-        NotificationSubscription.objects.create(user=self.user, node=self.node, event_name='event2')
+        NotificationSubscriptionLegacy.objects.create(user=self.user, node=self.node, event_name='event1')
+        NotificationSubscriptionLegacy.objects.create(user=self.user, node=self.node, event_name='event1')
+        NotificationSubscriptionLegacy.objects.create(user=self.user, node=self.node, event_name='event2')
 
         duplicates = detect_duplicate_notifications()
 

api/subscriptions/permissions.py

@@ -1,12 +1,12 @@
 from rest_framework import permissions
 
-from osf.models.notifications import NotificationSubscription
+from osf.models.notifications import NotificationSubscriptionLegacy
 
 
 class IsSubscriptionOwner(permissions.BasePermission):
 
     def has_object_permission(self, request, view, obj):
-        assert isinstance(obj, NotificationSubscription), f'obj must be a NotificationSubscription; got {obj}'
+        assert isinstance(obj, NotificationSubscriptionLegacy), f'obj must be a NotificationSubscriptionLegacy; got {obj}'
         user_id = request.user.id
         return obj.none.filter(id=user_id).exists() \
                or obj.email_transactional.filter(id=user_id).exists() \

api/subscriptions/views.py

@@ -22,6 +22,7 @@
     RegistrationProvider,
     AbstractProvider,
 )
+from osf.models.notifications import NotificationSubscriptionLegacy
 
 
 class SubscriptionList(JSONAPIBaseView, generics.ListAPIView, ListFilterMixin):
@@ -39,7 +40,7 @@ class SubscriptionList(JSONAPIBaseView, generics.ListAPIView, ListFilterMixin):
 
     def get_default_queryset(self):
         user = self.request.user
-        return NotificationSubscription.objects.filter(
+        return NotificationSubscriptionLegacy.objects.filter(
             Q(none=user) |
             Q(email_digest=user) |
             Q(
@@ -54,7 +55,7 @@ def get_queryset(self):
 class AbstractProviderSubscriptionList(SubscriptionList):
     def get_default_queryset(self):
         user = self.request.user
-        return NotificationSubscription.objects.filter(
+        return NotificationSubscriptionLegacy.objects.filter(
             provider___id=self.kwargs['provider_id'],
             provider__type=self.provider_class._typedmodels_type,
         ).filter(
@@ -80,7 +81,7 @@ class SubscriptionDetail(JSONAPIBaseView, generics.RetrieveUpdateAPIView):
     def get_object(self):
         subscription_id = self.kwargs['subscription_id']
         try:
-            obj = NotificationSubscription.objects.get(_id=subscription_id)
+            obj = NotificationSubscriptionLegacy.objects.get(_id=subscription_id)
         except ObjectDoesNotExist:
             raise NotFound
         self.check_object_permissions(self.request, obj)
@@ -109,15 +110,15 @@ def get_object(self):
         if self.kwargs.get('provider_id'):
             provider = self.provider_class.objects.get(_id=self.kwargs.get('provider_id'))
             try:
-                obj = NotificationSubscription.objects.get(
+                obj = NotificationSubscriptionLegacy.objects.get(
                     _id=subscription_id,
                     provider_id=provider.id,
                 )
             except ObjectDoesNotExist:
                 raise NotFound
         else:
             try:
-                obj = NotificationSubscription.objects.get(
+                obj = NotificationSubscriptionLegacy.objects.get(
                     _id=subscription_id,
                     provider__type=self.provider_class._typedmodels_type,
                 )

api_tests/subscriptions/views/test_subscriptions_detail.py

@@ -1,7 +1,7 @@
 import pytest
 
 from api.base.settings.defaults import API_BASE
-from osf_tests.factories import AuthUserFactory, NotificationSubscriptionFactory
+from osf_tests.factories import AuthUserFactory, NotificationSubscriptionLegacyFactory
 
 
 @pytest.mark.django_db
@@ -17,7 +17,7 @@ def user_no_auth(self):
 
     @pytest.fixture()
     def global_user_notification(self, user):
-        notification = NotificationSubscriptionFactory(_id=f'{user._id}_global', user=user, event_name='global')
+        notification = NotificationSubscriptionLegacyFactory(_id=f'{user._id}_global', user=user, event_name='global')
         notification.add_user_to_subscription(user, 'email_transactional')
         return notification
 

api_tests/subscriptions/views/test_subscriptions_list.py

@@ -1,7 +1,7 @@
 import pytest
 
 from api.base.settings.defaults import API_BASE
-from osf_tests.factories import AuthUserFactory, PreprintProviderFactory, ProjectFactory, NotificationSubscriptionFactory
+from osf_tests.factories import AuthUserFactory, PreprintProviderFactory, ProjectFactory, NotificationSubscriptionLegacyFactory
 
 
 @pytest.mark.django_db
@@ -23,7 +23,7 @@ def node(self, user):
 
     @pytest.fixture()
     def global_user_notification(self, user):
-        notification = NotificationSubscriptionFactory(_id=f'{user._id}_global', user=user, event_name='global')
+        notification = NotificationSubscriptionLegacyFactory(_id=f'{user._id}_global', user=user, event_name='global')
         notification.add_user_to_subscription(user, 'email_transactional')
         return notification
 

osf/email/__init__.py

@@ -0,0 +1,68 @@
+import logging
+import smtplib
+from email.mime.text import MIMEText
+from sendgrid import SendGridAPIClient
+from sendgrid.helpers.mail import Mail
+from website import settings
+
+def send_email_over_smtp(to_addr, notification_type, context):
+    """Send an email notification using SMTP. This is typically not used in productions as other 3rd party mail services
+    are preferred. This is to be used for tests and on staging environments and special situations.
+
+    Args:
+        to_addr (str): The recipient's email address.
+        notification_type (str): The subject of the notification.
+        context (dict): The email content context.
+    """
+    if not settings.MAIL_SERVER:
+        raise NotImplementedError('MAIL_SERVER is not set')
+    if not settings.MAIL_USERNAME and settings.MAIL_PASSWORD:
+        raise NotImplementedError('MAIL_USERNAME and MAIL_PASSWORD are required for STMP')
+
+    msg = MIMEText(
+        notification_type.template.format(context),
+        'html',
+        _charset='utf-8'
+    )
+    msg['Subject'] = notification_type.email_subject_line_template.format(context=context)
+
+    with smtplib.SMTP(settings.MAIL_SERVER) as server:
+        server.ehlo()
+        server.starttls()
+        server.ehlo()
+        server.login(settings.MAIL_USERNAME, settings.MAIL_PASSWORD)
+        server.sendmail(
+            settings.FROM_EMAIL,
+            [to_addr],
+            msg.as_string()
+        )
+
+
+def send_email_with_send_grid(to_addr, notification_type, context):
+    """Send an email notification using SendGrid.
+
+    Args:
+        to_addr (str): The recipient's email address.
+        notification_type (str): The subject of the notification.
+        context (dict): The email content context.
+    """
+    if not settings.SENDGRID_API_KEY:
+        raise NotImplementedError('SENDGRID_API_KEY is required for sendgrid notifications.')
+
+    message = Mail(
+        from_email=settings.FROM_EMAIL,
+        to_emails=to_addr,
+        subject=notification_type,
+        html_content=context.get('message', '')
+    )
+
+    try:
+        sg = SendGridAPIClient(settings.SENDGRID_API_KEY)
+        response = sg.send(message)
+        if response.status_code not in (200, 201, 202):
+            logging.error(f'SendGrid response error: {response.status_code}, body: {response.body}')
+            response.raise_for_status()
+        logging.info(f'Notification email sent to {to_addr} for {notification_type}.')
+    except Exception as exc:
+        logging.error(f'Failed to send email notification to {to_addr}: {exc}')
+        raise exc

osf/management/commands/add_notification_subscription.py

@@ -5,6 +5,7 @@
 import logging
 
 import django
+
 django.setup()
 
 from django.core.management.base import BaseCommand
@@ -20,9 +21,9 @@
 def add_reviews_notification_setting(notification_type, state=None):
     if state:
         OSFUser = state.get_model('osf', 'OSFUser')
-        NotificationSubscription = state.get_model('osf', 'NotificationSubscription')
+        NotificationSubscriptionLegacy = state.get_model('osf', 'NotificationSubscriptionLegacy')
     else:
-        from osf.models import OSFUser, NotificationSubscription
+        from osf.models import OSFUser, NotificationSubscriptionLegacy
 
     active_users = OSFUser.objects.filter(date_confirmed__isnull=False).exclude(date_disabled__isnull=False).exclude(is_active=False).order_by('id')
     total_active_users = active_users.count()
@@ -33,10 +34,10 @@ def add_reviews_notification_setting(notification_type, state=None):
     for user in active_users.iterator():
         user_subscription_id = to_subscription_key(user._id, notification_type)
 
-        subscription = NotificationSubscription.load(user_subscription_id)
+        subscription = NotificationSubscriptionLegacy.load(user_subscription_id)
         if not subscription:
             logger.info(f'No {notification_type} subscription found for user {user._id}. Subscribing...')
-            subscription = NotificationSubscription(_id=user_subscription_id, owner=user, event_name=notification_type)
+            subscription = NotificationSubscriptionLegacy(_id=user_subscription_id, owner=user, event_name=notification_type)
             subscription.save()  # Need to save in order to access m2m fields
             subscription.add_user_to_subscription(user, 'email_transactional')
         else:

osf/management/commands/populate_collection_provider_notification_subscriptions.py

@@ -1,7 +1,7 @@
 import logging
 
 from django.core.management.base import BaseCommand
-from osf.models import NotificationSubscription, CollectionProvider
+from osf.models import NotificationSubscriptionLegacy, CollectionProvider
 
 logger = logging.getLogger(__file__)
 
@@ -12,7 +12,7 @@ def populate_collection_provider_notification_subscriptions():
         provider_moderators = provider.get_group('moderator').user_set.all()
 
         for subscription in provider.DEFAULT_SUBSCRIPTIONS:
-            instance, created = NotificationSubscription.objects.get_or_create(
+            instance, created = NotificationSubscriptionLegacy.objects.get_or_create(
                 _id=f'{provider._id}_{subscription}',
                 event_name=subscription,
                 provider=provider

osf/management/commands/populate_registration_provider_notification_subscriptions.py

@@ -2,7 +2,7 @@
 
 from django.contrib.auth.models import Group
 from django.core.management.base import BaseCommand
-from osf.models import NotificationSubscription, RegistrationProvider
+from osf.models import RegistrationProvider, NotificationSubscriptionLegacy
 
 logger = logging.getLogger(__file__)
 
@@ -17,7 +17,7 @@ def populate_registration_provider_notification_subscriptions():
             continue
 
         for subscription in provider.DEFAULT_SUBSCRIPTIONS:
-            instance, created = NotificationSubscription.objects.get_or_create(
+            instance, created = NotificationSubscriptionLegacy.objects.get_or_create(
                 _id=f'{provider._id}_{subscription}',
                 event_name=subscription,
                 provider=provider