Merge pull request #147 from City-of-Helsinki/release/1.5.0

Release 1.5.0

Author: tuomas777

.prod/uwsgi.ini

@@ -11,4 +11,4 @@ processes = 2
 threads = 2
 cron = -1 -1 -1 -1 -1 /app/manage.py send_mail
 cron = -20 -1 -1 -1 -1 /app/manage.py retry_deferred
-cron = 0 0 -1 -1 -1 /app/manage.py purge_mail_log 7
+cron = 0 12 -1 -1 -1 /app/manage.py send_reminder_notifications

CHANGELOG.md

@@ -1,6 +1,15 @@
 <!-- REMINDER: While updating changelog, also remember to update
 the version in kukkuu/__init.py__ -->
 
+## [1.5.0] - 30 Sep 2020
+### Added
+- Add upcoming occurrence reminder notification
+- Add `upcoming_with_leeway` occurrence filter
+- Add enrolled events past enough (default 30 mins from the start) to a child's past events
+- Add initial API for subscribing and viewing free spot subscriptions (N.B. the functionality itself has NOT been implemented yet, just the API)
+### Changed
+- Do not purge email logs by default in CI/CD config
+
 ## [1.4.0] - 15 Sep 2020
 ### Added
 - Add nullable field `capacityOverride` and API for it which allows setting capacity per occurrence
@@ -101,7 +110,8 @@ the version in kukkuu/__init.py__ -->
 
 
 
-[Unreleased]: https://github.com/City-of-Helsinki/kukkuu/compare/v1.4.0...HEAD
+[Unreleased]: https://github.com/City-of-Helsinki/kukkuu/compare/v1.5.0...HEAD
+[1.4.0]: https://github.com/City-of-Helsinki/kukkuu/compare/v1.4.0...v1.5.0
 [1.4.0]: https://github.com/City-of-Helsinki/kukkuu/compare/v1.3.0...v1.4.0
 [1.3.0]: https://github.com/City-of-Helsinki/kukkuu/compare/v1.2.0...v1.3.0
 [1.2.0]: https://github.com/City-of-Helsinki/kukkuu/compare/v1.1.0...v1.2.0

README.md

@@ -50,19 +50,29 @@ Add default languages (optional)
     python manage.py add_languages --default
 
 ### Cron jobs
-By default email sending won't be queued. In case you want to queue emails:
- - In `settings.py` configure `ILMOITIN_QUEUE_NOTIFICATIONS` to `True`
- - Install `cron` in your host machine
- - Add a crontab to execute the email delivery, here is an example:
+`cron` is required for sending reminder notifications, and for sending emails queued (optional).
+
+#### Reminder notifications
+
+To send reminder notifications on time, `send_reminder_notifications` management command needs to be executed (at least) daily.
+
+Example crontab for sending reminder notifications every day at 12am:
+
+    0 12 * * * (/path/to/your/python path/to/your/app/manage.py send_reminder_notifications > /var/log/cron.log 2>&1)
+    # An empty line is required at the end of this file for a valid cron file.
+
+#### Queued email sending
+
+By default email sending won't be queued. To enable queued emails, configure setting `ILMOITIN_QUEUE_NOTIFICATIONS` to `True`, and set `send_mail` and `retry_deferred` to be executed periodically.
+
+Example crontab for queued emails (includes reminder notification sending as well):
 
-    ```
-    *       * * * * (/path/to/your/python path/to/your/app/manage.py send_mail > /var/log/cron.log 2>&1)
+    * * * * * (/path/to/your/python path/to/your/app/manage.py send_mail > /var/log/cron.log 2>&1)
     0,20,40 * * * * (/path/to/your/python path/to/your/app/manage.py retry_deferred > /var/log/cron.log 2>&1)
     0 0 * * * (/path/to/your/python path/to/your/app/manage.py purge_mail_log 7 > /var/log/cron.log 2>&1)
+    0 12 * * * (/path/to/your/python path/to/your/app/manage.py send_reminder_notifications > /var/log/cron.log 2>&1)
     # An empty line is required at the end of this file for a valid cron file.
 
-    ```
-
 ### Daily running, Debugging
 
 * Create `.env` file: `touch .env`

children/admin.py

@@ -1,6 +1,7 @@
 from django.contrib import admin
 from django.utils.translation import ugettext_lazy as _
 from languages.models import Language
+from subscriptions.models import FreeSpotNotificationSubscription
 
 from events.models import Enrolment
 
@@ -30,6 +31,12 @@ class LanguagesSpokenAtHomeInline(admin.TabularInline):
     verbose_name_plural = _("Languages spoken at home")
 
 
+class SubscriptionInline(admin.TabularInline):
+    model = FreeSpotNotificationSubscription
+    extra = 0
+    readonly_fields = ("created_at",)
+
+
 @admin.register(Child)
 class ChildAdmin(admin.ModelAdmin):
     list_display = (
@@ -45,7 +52,12 @@ class ChildAdmin(admin.ModelAdmin):
     list_select_related = ("project",)
     fields = ("project", "first_name", "last_name", "birthdate", "postal_code")
     search_fields = ("first_name", "last_name")
-    inlines = (RelationshipInline, EnrolmentInline, LanguagesSpokenAtHomeInline)
+    inlines = (
+        RelationshipInline,
+        EnrolmentInline,
+        LanguagesSpokenAtHomeInline,
+        SubscriptionInline,
+    )
 
     def get_project_year(self, obj):
         return obj.project.year

children/schema.py

@@ -1,4 +1,5 @@
 import logging
+from datetime import timedelta
 
 import graphene
 from django.conf import settings
@@ -56,6 +57,24 @@ class Meta:
         model = Child
         interfaces = (relay.Node,)
         connection_class = ChildrenConnection
+        fields = (
+            "id",
+            "created_at",
+            "updated_at",
+            "first_name",
+            "last_name",
+            "postal_code",
+            "birthdate",
+            "guardians",
+            "project",
+            "languages_spoken_at_home",
+            "relationships",
+            "occurrences",
+            "enrolments",
+            "available_events",
+            "past_events",
+            "free_spot_notification_subscriptions",
+        )
         filter_fields = ("project_id",)
 
     @classmethod
@@ -74,13 +93,30 @@ def get_node(cls, info, id):
             return None
 
     def resolve_past_events(self, info, **kwargs):
-        return (
-            self.project.events.user_can_view(info.context.user)
-            .published()
-            .exclude(occurrences__time__gte=timezone.now())
-            .distinct()
+        """
+        Past events include:
+
+        1) Events the user has not enrolled AND are completely (all occurrences) in the
+           past
+        2) Events the user has enrolled AND the occurrence of the enrolment is more than
+           KUKKUU_ENROLLED_OCCURRENCE_IN_PAST_LEEWAY mins in the past.
+        """
+        events = self.project.events.user_can_view(info.context.user).published()
+
+        past_unparticipated_events = events.exclude(
+            occurrences__in=self.occurrences.all()
+        ).exclude(occurrences__time__gte=timezone.now())
+
+        past_enough_enrolled_occurrences = self.occurrences.filter(
+            time__lt=timezone.now()
+            - timedelta(minutes=settings.KUKKUU_ENROLLED_OCCURRENCE_IN_PAST_LEEWAY)
+        )
+        past_enough_participated_events = events.filter(
+            occurrences__in=past_enough_enrolled_occurrences
         )
 
+        return past_unparticipated_events | past_enough_participated_events
+
     def resolve_available_events(self, info, **kwargs):
         return (
             self.project.events.user_can_view(info.context.user)

children/tests/snapshots/snap_test_api.py

@@ -378,27 +378,6 @@
     }
 }
 
-snapshots["test_get_past_events 1"] = {
-    "data": {
-        "child": {
-            "availableEvents": {"edges": []},
-            "occurrences": {"edges": [{"node": {"time": "1969-12-31T22:20:00+00:00"}}]},
-            "pastEvents": {
-                "edges": [
-                    {
-                        "node": {
-                            "createdAt": "2020-12-12T00:00:00+00:00",
-                            "occurrences": {
-                                "edges": [{"node": {"remainingCapacity": 0}}]
-                            },
-                        }
-                    }
-                ]
-            },
-        }
-    }
-}
-
 snapshots["test_children_project_filter 1"] = {
     "data": {
         "children": {
@@ -539,3 +518,59 @@
         }
     }
 }
+
+snapshots["test_get_past_events 1"] = {
+    "data": {
+        "child": {
+            "availableEvents": {
+                "edges": [
+                    {
+                        "node": {
+                            "createdAt": "2020-12-12T00:00:00+00:00",
+                            "occurrences": {
+                                "edges": [
+                                    {"node": {"remainingCapacity": 0}},
+                                    {"node": {"remainingCapacity": 0}},
+                                ]
+                            },
+                        }
+                    }
+                ]
+            },
+            "occurrences": {
+                "edges": [
+                    {"node": {"time": "2020-12-11T23:29:00+00:00"}},
+                    {"node": {"time": "2020-12-11T23:31:00+00:00"}},
+                ]
+            },
+            "pastEvents": {
+                "edges": [
+                    {
+                        "node": {
+                            "createdAt": "2020-12-12T00:00:00+00:00",
+                            "name": "enrolled occurrence in the past",
+                            "occurrences": {
+                                "edges": [
+                                    {"node": {"remainingCapacity": 23}},
+                                    {"node": {"remainingCapacity": 24}},
+                                ]
+                            },
+                        }
+                    },
+                    {
+                        "node": {
+                            "createdAt": "2020-12-12T00:00:00+00:00",
+                            "name": "event in the past",
+                            "occurrences": {
+                                "edges": [
+                                    {"node": {"remainingCapacity": 32}},
+                                    {"node": {"remainingCapacity": 32}},
+                                ]
+                            },
+                        }
+                    },
+                ]
+            },
+        }
+    }
+}

children/tests/test_api.py

@@ -431,6 +431,7 @@ def test_children_project_filter(
       edges{
         node{
           createdAt
+          name
           occurrences{
             edges{
               node{
@@ -776,50 +777,71 @@ def test_get_past_events(
 
     next_project = ProjectFactory(year=2021)
 
-    # Unpublished occurrences
-    OccurrenceFactory.create_batch(
-        2, time=timezone.now(), event=EventFactory(project=project), venue=venue
+    past = timezone.now() - timedelta(
+        minutes=settings.KUKKUU_ENROLLED_OCCURRENCE_IN_PAST_LEEWAY + 1
+    )
+    not_enough_past = timezone.now() - timedelta(
+        minutes=settings.KUKKUU_ENROLLED_OCCURRENCE_IN_PAST_LEEWAY - 1
     )
+    future = timezone.now() + timedelta(minutes=1)
 
-    # Published occurrences in the past
-    event = EventFactory(published_at=timezone.now(), project=project)
-    past_occurrence_1 = OccurrenceFactory(
-        time=datetime(1970, 1, 1, 0, 0, 0, tzinfo=pytz.timezone(settings.TIME_ZONE)),
-        event=event,
-        venue=venue,
+    # Enrolled occurrence in the past, event should be visible
+    event = EventFactory(
+        published_at=timezone.now(),
+        project=project,
+        name="enrolled occurrence in the past",
     )
+    OccurrenceFactory(time=future, event=event, venue=venue)
+    the_past_occurrence = OccurrenceFactory(time=past, event=event, venue=venue)
+    EnrolmentFactory(child=child_with_user_guardian, occurrence=the_past_occurrence)
 
-    OccurrenceFactory(
-        time=datetime(1970, 1, 1, 0, 0, 0, tzinfo=pytz.timezone(settings.TIME_ZONE)),
-        event__published_at=timezone.now(),
-        event__project=project,
-        venue=venue,
+    # Enrolled occurrence in the past but not enough, event should be NOT visible
+    event_2 = EventFactory(
+        published_at=timezone.now(),
+        project=project,
+        name="enrolled occurrence in the past but not enough",
+    )
+    OccurrenceFactory(time=future, event=event_2, venue=venue)
+    the_not_so_past_occurrence = OccurrenceFactory(
+        time=not_enough_past, event=event_2, venue=venue
+    )
+    EnrolmentFactory(
+        child=child_with_user_guardian, occurrence=the_not_so_past_occurrence
     )
-    # Past occurrence but from another project
+
+    # Event without an enrolment in the past, should be visible
+    event_3 = EventFactory(
+        published_at=timezone.now(), project=project, name="event in the past"
+    )
+    OccurrenceFactory(time=past, event=event_3, venue=venue)
+    OccurrenceFactory(time=not_enough_past, event=event_3, venue=venue)
+
+    # Event without an enrolment in the future, should NOT be visible
+    event_4 = EventFactory(
+        published_at=timezone.now(), project=project, name="event in the future"
+    )
+    OccurrenceFactory(time=not_enough_past, event=event_4, venue=venue)
+    OccurrenceFactory(time=future, event=event_4, venue=venue)
+
+    # Past occurrence but from another project, should NOT be visible
     OccurrenceFactory(
-        time=datetime(1970, 1, 1, 0, 0, 0, tzinfo=pytz.timezone(settings.TIME_ZONE)),
+        time=past,
         event__published_at=timezone.now(),
         event__project=next_project,
+        event__name="another project event",
         venue=venue,
     )
 
-    # Recent published occurrence
-    OccurrenceFactory(time=timezone.now(), event=event, venue=venue)
-
-    # Unpublished occurrences in the past
+    # Unpublished occurrences in the past, should NOT be visible
     OccurrenceFactory.create_batch(
         3,
         time=datetime(1970, 1, 1, 0, 0, 0, tzinfo=pytz.timezone(settings.TIME_ZONE)),
         event__project=project,
+        event__name="unpublished event in the past",
         venue=venue,
     )
 
-    EnrolmentFactory(child=child_with_user_guardian, occurrence=past_occurrence_1)
-
     executed = guardian_api_client.execute(CHILD_EVENTS_QUERY, variables=variables)
-    # Still return enroled events if they are past events
-    # Should only return past events from current project
-    assert len(executed["data"]["child"]["pastEvents"]["edges"]) == 1
     snapshot.assert_match(executed)
 
     guardian_api_client.user.projects.add(project)

common/tests/conftest.py

@@ -26,6 +26,7 @@ def setup_test_environment(settings):
     settings.DEFAULT_FROM_EMAIL = "kukkuu@example.com"
     settings.ILMOITIN_TRANSLATED_FROM_EMAIL = {}
     settings.MEDIA_ROOT = "test_media"
+    settings.KUKKUU_REMINDER_DAYS_IN_ADVANCE = 7
     with translation.override("fi"), freeze_time("2020-12-12"):
         yield
     shutil.rmtree("test_media", ignore_errors=True)

common/utils.py

@@ -1,3 +1,4 @@
+import binascii
 from copy import deepcopy
 
 from django.db import transaction
@@ -39,7 +40,13 @@ def get_global_id(obj):
 
 
 def get_node_id_from_global_id(global_id, expected_node_name):
-    name, id = from_global_id(global_id)
+    try:
+        name, id = from_global_id(global_id)
+    except (
+        binascii.Error,
+        UnicodeDecodeError,
+    ):  # invalid global ID
+        return None
     return id if name == expected_node_name else None