codeforlife-portal 7.0.0__tar.gz → 7.1.0__tar.gz

{codeforlife-portal-7.0.0/codeforlife_portal.egg-info → codeforlife-portal-7.1.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: codeforlife-portal
-Version: 7.0.0
+Version: 7.1.0
 Classifier: Programming Language :: Python
 Classifier: Programming Language :: Python :: 3.8
 Classifier: Framework :: Django

{codeforlife-portal-7.0.0 → codeforlife-portal-7.1.0/codeforlife_portal.egg-info}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: codeforlife-portal
-Version: 7.0.0
+Version: 7.1.0
 Classifier: Programming Language :: Python
 Classifier: Programming Language :: Python :: 3.8
 Classifier: Framework :: Django

{codeforlife-portal-7.0.0 → codeforlife-portal-7.1.0}/codeforlife_portal.egg-info/requires.txt

@@ -16,7 +16,7 @@ django-classy-tags==2.0.0
 libsass==0.23.0
 phonenumbers==8.12.12
 more-itertools==8.7.0
-cfl-common==7.0.0
+cfl-common==7.1.0
 django-ratelimit==3.0.1
 django-preventconcurrentlogins==0.8.2
 django-csp==3.7

codeforlife-portal-7.1.0/portal/__init__.py

@@ -0,0 +1 @@
+__version__ = "7.1.0"

{codeforlife-portal-7.0.0 → codeforlife-portal-7.1.0}/portal/tests/test_views.py

@@ -16,6 +16,7 @@ from common.models import (
     UserProfile,
     UserSession,
 )
+from common.mail import campaign_ids
 from common.tests.utils.classes import create_class_directly
 from common.tests.utils.organisation import (
     create_organisation_directly,
@@ -1197,3 +1198,103 @@ class TestUser(CronTestCase):
             is_verified=False,
             assert_active=False,
         )
+
+    @patch("portal.views.cron.user.send_dotdigital_email")
+    def send_inactivity_reminder(
+        self,
+        days: int,
+        view_name: str,
+        assert_called: bool,
+        campaign_name: str,
+        mock_send_dotdigital_email: Mock,
+    ):
+        self.teacher_user.date_joined = timezone.now() - timedelta(
+            days=days, hours=12
+        )
+        self.teacher_user.save()
+        self.student_user.date_joined = timezone.now() - timedelta(
+            days=days, hours=12
+        )
+        self.student_user.save()
+        self.indy_user.last_login = timezone.now() - timedelta(
+            days=days, hours=12
+        )
+        self.indy_user.save()
+
+        self.client.get(reverse(view_name))
+
+        if assert_called:
+            mock_send_dotdigital_email.assert_any_call(
+                campaign_ids[campaign_name], [self.teacher_user.email]
+            )
+
+            mock_send_dotdigital_email.assert_any_call(
+                campaign_ids[campaign_name], [self.indy_user.email]
+            )
+
+            # Check only two emails are sent - the student should never be included.
+            assert mock_send_dotdigital_email.call_count == 2
+        else:
+            mock_send_dotdigital_email.assert_not_called()
+
+        mock_send_dotdigital_email.reset_mock()
+
+    def test_first_inactivity_reminder_view(self):
+        self.send_inactivity_reminder(
+            729,
+            "first-inactivity-reminder",
+            False,
+            "inactive_users_on_website_first_reminder",
+        )
+        self.send_inactivity_reminder(
+            730,
+            "first-inactivity-reminder",
+            True,
+            "inactive_users_on_website_first_reminder",
+        )
+        self.send_inactivity_reminder(
+            731,
+            "first-inactivity-reminder",
+            False,
+            "inactive_users_on_website_first_reminder",
+        )
+
+    def test_second_inactivity_reminder_view(self):
+        self.send_inactivity_reminder(
+            972,
+            "second-inactivity-reminder",
+            False,
+            "inactive_users_on_website_second_reminder",
+        )
+        self.send_inactivity_reminder(
+            973,
+            "second-inactivity-reminder",
+            True,
+            "inactive_users_on_website_second_reminder",
+        )
+        self.send_inactivity_reminder(
+            974,
+            "second-inactivity-reminder",
+            False,
+            "inactive_users_on_website_second_reminder",
+        )
+
+    def test_final_inactivity_reminder_view(self):
+        self.send_inactivity_reminder(
+            1064,
+            "final-inactivity-reminder",
+            False,
+            "inactive_users_on_website_final_reminder",
+        )
+        self.send_inactivity_reminder(
+            1065,
+            "final-inactivity-reminder",
+            True,
+            "inactive_users_on_website_final_reminder",
+        )
+        self.send_inactivity_reminder(
+            1066,
+            "final-inactivity-reminder",
+            False,
+            "inactive_users_on_website_final_reminder",
+        )

{codeforlife-portal-7.0.0 → codeforlife-portal-7.1.0}/portal/urls.py

@@ -164,6 +164,21 @@ urlpatterns = [
                                 cron.user.AnonymiseUnverifiedAccounts.as_view(),
                                 name="anonymise-unverified-accounts",
                             ),
+                            path(
+                                "inactive/send-first-reminder/",
+                                cron.user.FirstInactivityReminderView.as_view(),
+                                name="first-inactivity-reminder",
+                            ),
+                            path(
+                                "inactive/send-second-reminder/",
+                                cron.user.SecondInactivityReminderView.as_view(),
+                                name="second-inactivity-reminder",
+                            ),
+                            path(
+                                "inactive/send-final-reminder/",
+                                cron.user.FinalInactivityReminderView.as_view(),
+                                name="final-inactivity-reminder",
+                            ),
                         ]
                     ),
                 ),

{codeforlife-portal-7.0.0 → codeforlife-portal-7.1.0}/portal/views/cron/user.py

@@ -5,24 +5,28 @@ from common.helpers.emails import generate_token_for_email
 from common.mail import campaign_ids, send_dotdigital_email
 from common.models import DailyActivity, TotalActivity
 from django.contrib.auth.models import User
-from django.db.models import F
+from django.db.models import F, Q
 from django.db.models.query import QuerySet
 from django.urls import reverse
 from django.utils import timezone
 from rest_framework.response import Response
 from rest_framework.views import APIView
 
-from portal.views.api import anonymise
-
 from ...mixins import CronMixin
+from ...views.api import anonymise
 
-# TODO: move email templates to DotDigital.
 USER_1ST_VERIFY_EMAIL_REMINDER_DAYS = 7
 USER_2ND_VERIFY_EMAIL_REMINDER_DAYS = 14
 USER_DELETE_UNVERIFIED_ACCOUNT_DAYS = 19
 
+USER_1ST_INACTIVE_REMINDER_DAYS = 730  # 2 years
+USER_2ND_INACTIVE_REMINDER_DAYS = 973  # roughly 2 years and 8 months
+USER_FINAL_INACTIVE_REMINDER_DAYS = 1065  # 2 years and 11 months
+
 
-def get_unverified_users(days: int, same_day: bool) -> (QuerySet[User], QuerySet[User]):
+def get_unverified_users(
+    days: int, same_day: bool
+) -> (QuerySet[User], QuerySet[User]):
     now = timezone.now()
 
     # All expired unverified users.
@@ -31,7 +35,9 @@ def get_unverified_users(days: int, same_day: bool) -> (QuerySet[User], QuerySet
         userprofile__is_verified=False,
     )
     if same_day:
-        user_queryset = user_queryset.filter(date_joined__gt=now - timedelta(days=days + 1))
+        user_queryset = user_queryset.filter(
+            date_joined__gt=now - timedelta(days=days + 1)
+        )
 
     teacher_queryset = user_queryset.filter(
         new_teacher__isnull=False,
@@ -45,10 +51,31 @@ def get_unverified_users(days: int, same_day: bool) -> (QuerySet[User], QuerySet
     return teacher_queryset, independent_student_queryset
 
 
+def get_inactive_users(days: int) -> QuerySet[User]:
+    now = timezone.now()
+
+    # All users who haven't logged in in X days OR who've never logged in and
+    # registered over X days ago.
+    user_queryset = User.objects.filter(
+        Q(
+            last_login__isnull=False,
+            last_login__lte=now - timedelta(days=days),
+            last_login__gt=now - timedelta(days=days + 1),
+        )
+        | Q(
+            last_login__isnull=True,
+            date_joined__lte=now - timedelta(days=days),
+            date_joined__gt=now - timedelta(days=days + 1),
+        )
+    )
+
+    return user_queryset.exclude(email__isnull=True).exclude(email="")
+
+
 def build_absolute_google_uri(request, location: str) -> str:
     """
-    This is needed specifically for emails sent by cron jobs as the protocol for cron jobs is HTTP
-    and the service name is wrongly parsed.
+    This is needed specifically for emails sent by cron jobs as the protocol for
+    cron jobs is HTTP and the service name is wrongly parsed.
     """
     url = request.build_absolute_uri(location)
     url = url.replace("http", "https")
@@ -70,7 +97,9 @@ class FirstVerifyEmailReminderView(CronMixin, APIView):
 
         if user_count > 0:
             sent_email_count = 0
-            for email in user_queryset.values_list("email", flat=True).iterator(chunk_size=500):
+            for email in user_queryset.values_list("email", flat=True).iterator(
+                chunk_size=500
+            ):
                 email_verification_url = build_absolute_google_uri(
                     request,
                     reverse(
@@ -83,7 +112,9 @@ class FirstVerifyEmailReminderView(CronMixin, APIView):
                     send_dotdigital_email(
                         campaign_ids["verify_new_user_first_reminder"],
                         [email],
-                        personalization_values={"VERIFICATION_LINK": email_verification_url},
+                        personalization_values={
+                            "VERIFICATION_LINK": email_verification_url
+                        },
                     )
 
                     sent_email_count += 1
@@ -109,7 +140,9 @@ class SecondVerifyEmailReminderView(CronMixin, APIView):
         if user_count > 0:
 
             sent_email_count = 0
-            for email in user_queryset.values_list("email", flat=True).iterator(chunk_size=500):
+            for email in user_queryset.values_list("email", flat=True).iterator(
+                chunk_size=500
+            ):
                 email_verification_url = build_absolute_google_uri(
                     request,
                     reverse(
@@ -122,7 +155,9 @@ class SecondVerifyEmailReminderView(CronMixin, APIView):
                     send_dotdigital_email(
                         campaign_ids["verify_new_user_second_reminder"],
                         [email],
-                        personalization_values={"VERIFICATION_LINK": email_verification_url},
+                        personalization_values={
+                            "VERIFICATION_LINK": email_verification_url
+                        },
                     )
 
                     sent_email_count += 1
@@ -157,14 +192,122 @@ class AnonymiseUnverifiedAccounts(CronMixin, APIView):
         user_count -= User.objects.filter(is_active=True).count()
         logging.info(f"{user_count} unverified users anonymised.")
 
-        activity_today = DailyActivity.objects.get_or_create(date=datetime.now().date())[0]
+        activity_today = DailyActivity.objects.get_or_create(
+            date=datetime.now().date()
+        )[0]
         activity_today.anonymised_unverified_teachers = teacher_count
         activity_today.anonymised_unverified_independents = indy_count
         activity_today.save()
 
         TotalActivity.objects.update(
-            anonymised_unverified_teachers=F("anonymised_unverified_teachers") + teacher_count,
-            anonymised_unverified_independents=F("anonymised_unverified_independents") + indy_count,
+            anonymised_unverified_teachers=F("anonymised_unverified_teachers")
+            + teacher_count,
+            anonymised_unverified_independents=F(
+                "anonymised_unverified_independents"
+            )
+            + indy_count,
+        )
+
+        return Response()
+
+
+class FirstInactivityReminderView(CronMixin, APIView):
+    def get(self, request):
+        user_queryset = get_inactive_users(USER_1ST_INACTIVE_REMINDER_DAYS)
+        user_count = user_queryset.count()
+
+        logging.info(
+            f"{user_count} inactive users after "
+            f"{USER_1ST_INACTIVE_REMINDER_DAYS} days."
+        )
+
+        if user_count > 0:
+            sent_email_count = 0
+            for email in user_queryset.values_list("email", flat=True).iterator(
+                chunk_size=500
+            ):
+                try:
+                    send_dotdigital_email(
+                        campaign_ids[
+                            "inactive_users_on_website_first_reminder"
+                        ],
+                        [email],
+                    )
+
+                    sent_email_count += 1
+                except Exception as ex:
+                    logging.exception(ex)
+
+            logging.info(
+                f"Reminded {sent_email_count}/{user_count} inactive users."
+            )
+
+        return Response()
+
+
+class SecondInactivityReminderView(CronMixin, APIView):
+    def get(self, request):
+        user_queryset = get_inactive_users(USER_2ND_INACTIVE_REMINDER_DAYS)
+        user_count = user_queryset.count()
+
+        logging.info(
+            f"{user_count} inactive users after "
+            f"{USER_2ND_INACTIVE_REMINDER_DAYS} days."
+        )
+
+        if user_count > 0:
+            sent_email_count = 0
+            for email in user_queryset.values_list("email", flat=True).iterator(
+                chunk_size=500
+            ):
+                try:
+                    send_dotdigital_email(
+                        campaign_ids[
+                            "inactive_users_on_website_second_reminder"
+                        ],
+                        [email],
+                    )
+
+                    sent_email_count += 1
+                except Exception as ex:
+                    logging.exception(ex)
+
+            logging.info(
+                f"Reminded {sent_email_count}/{user_count} inactive users."
+            )
+
+        return Response()
+
+
+class FinalInactivityReminderView(CronMixin, APIView):
+    def get(self, request):
+        user_queryset = get_inactive_users(USER_FINAL_INACTIVE_REMINDER_DAYS)
+        user_count = user_queryset.count()
+
+        logging.info(
+            f"{user_count} inactive users after "
+            f"{USER_FINAL_INACTIVE_REMINDER_DAYS} days."
         )
 
+        if user_count > 0:
+            sent_email_count = 0
+            for email in user_queryset.values_list("email", flat=True).iterator(
+                chunk_size=500
+            ):
+                try:
+                    send_dotdigital_email(
+                        campaign_ids[
+                            "inactive_users_on_website_final_reminder"
+                        ],
+                        [email],
+                    )
+
+                    sent_email_count += 1
+                except Exception as ex:
+                    logging.exception(ex)
+
+            logging.info(
+                f"Reminded {sent_email_count}/{user_count} inactive users."
+            )
+
         return Response()

codeforlife-portal-7.0.0/portal/__init__.py

@@ -1 +0,0 @@
-__version__ = "7.0.0"