[#1760] Implemented User Feed app & CMS plugin

Author: Bart van der Schoor

src/open_inwoner/cms/cases/views/status.py

@@ -55,6 +55,8 @@
     ZaakTypeStatusTypeConfig,
 )
 from open_inwoner.openzaak.utils import get_role_name_display, is_info_object_visible
+from open_inwoner.userfeed.hooks.case_document import case_documents_seen
+from open_inwoner.userfeed.hooks.case_status import case_status_seen
 from open_inwoner.utils.time import has_new_elements
 from open_inwoner.utils.translate import TranslationLookup
 from open_inwoner.utils.views import CommonPageMixin, LogMixin
@@ -218,6 +220,10 @@ def get_context_data(self, **kwargs):
                 self.case, self.resulttype_config_mapping
             )
 
+            # flag case seen in user feed
+            case_status_seen(self.request.user, self.case)
+            case_documents_seen(self.request.user, self.case)
+
             context["case"] = {
                 "id": str(self.case.uuid),
                 "identification": self.case.identification,

src/open_inwoner/cms/plugins/cms_plugins/__init__.py

@@ -1 +1,2 @@
+from .userfeed import UserFeedPlugin
 from .videoplayer import VideoPlayerPlugin

src/open_inwoner/cms/plugins/cms_plugins/userfeed.py

@@ -0,0 +1,26 @@
+from django.utils.translation import gettext as _
+
+from cms.plugin_base import CMSPluginBase
+from cms.plugin_pool import plugin_pool
+
+from open_inwoner.cms.plugins.models.userfeed import UserFeed
+from open_inwoner.userfeed.feed import get_feed
+
+
+@plugin_pool.register_plugin
+class UserFeedPlugin(CMSPluginBase):
+    model = UserFeed
+    module = _("General")
+    name = _("User Feed")
+    render_template = "cms/plugins/userfeed/userfeed.html"
+
+    def render(self, context, instance, placeholder):
+        request = context["request"]
+        feed = get_feed(request.user)
+        context.update(
+            {
+                "instance": instance,
+                "userfeed": feed,
+            }
+        )
+        return context

src/open_inwoner/cms/plugins/migrations/0002_userfeed.py

@@ -0,0 +1,36 @@
+# Generated by Django 3.2.23 on 2024-01-05 08:26
+
+import django.db.models.deletion
+from django.db import migrations, models
+
+
+class Migration(migrations.Migration):
+
+    dependencies = [
+        ("cms", "0022_auto_20180620_1551"),
+        ("plugins", "0001_initial"),
+    ]
+
+    operations = [
+        migrations.CreateModel(
+            name="UserFeed",
+            fields=[
+                (
+                    "cmsplugin_ptr",
+                    models.OneToOneField(
+                        auto_created=True,
+                        on_delete=django.db.models.deletion.CASCADE,
+                        parent_link=True,
+                        primary_key=True,
+                        related_name="plugins_userfeed",
+                        serialize=False,
+                        to="cms.cmsplugin",
+                    ),
+                ),
+            ],
+            options={
+                "abstract": False,
+            },
+            bases=("cms.cmsplugin",),
+        ),
+    ]

src/open_inwoner/cms/plugins/models/__init__.py

@@ -1 +1,2 @@
+from .userfeed import UserFeed
 from .videoplayer import VideoPlayer

src/open_inwoner/cms/plugins/models/userfeed.py

@@ -0,0 +1,6 @@
+from cms.models import CMSPlugin
+
+
+class UserFeed(CMSPlugin):
+    # TODO add options
+    pass

src/open_inwoner/cms/plugins/tests/test_userfeed.py

@@ -0,0 +1,50 @@
+from django.test import TestCase
+from django.utils.html import strip_tags
+from django.utils.translation import ugettext as _
+
+from pyquery import PyQuery as PQ
+
+from open_inwoner.accounts.tests.factories import UserFactory
+from open_inwoner.cms.tests import cms_tools
+from open_inwoner.userfeed.hooks.common import simple_message
+
+from ..cms_plugins import UserFeedPlugin
+
+
+class TestUserFeedPlugin(TestCase):
+    def test_plugin(self):
+        user = UserFactory()
+        simple_message(user, "Hello", title="Test message", url="http://foo.bar")
+
+        html, context = cms_tools.render_plugin(
+            UserFeedPlugin, plugin_data={}, user=user
+        )
+
+        feed = context["userfeed"]
+        self.assertEqual(feed.total_items, 1)
+
+        self.assertIn("Test message", html)
+        self.assertIn("Hello", html)
+
+        pyquery = PQ(html)
+
+        # test summary
+        summaries = pyquery.find(".userfeed__summary .userfeed__list-item")
+        self.assertEqual(len(summaries), 1)
+
+        summary = summaries.text()
+        expected = _("There is {count} message").format(count=1)
+        self.assertEqual(strip_tags(summary), expected)
+
+        # test item
+        items = pyquery.find(".card-container .card")
+        self.assertEqual(len(items), 1)
+
+        title = items.find("p.tabled__value").text()
+        self.assertEqual(title, "Test message")
+
+        message = items.find(".userfeed__heading").text()
+        self.assertEqual(message, "Hello")
+
+        action_url = items[0].attrib["href"]
+        self.assertEqual(action_url, "http://foo.bar")

src/open_inwoner/cms/utils/page_display.py

@@ -1,6 +1,8 @@
 """Utilities for determining whether CMS pages are published"""
 
 
+from django.db.models import Q
+
 from cms.models import Page
 
 from open_inwoner.cms.benefits.cms_apps import SSDApphook
@@ -52,3 +54,15 @@ def benefits_page_is_published() -> bool:
     :returns: True if the social benefits page published, False otherwise
     """
     return _is_published("ssd")
+
+
+def get_active_app_names() -> list[str]:
+    return list(
+        Page.objects.published()
+        .exclude(
+            Q(application_urls="")
+            | Q(application_urls__isnull=True)
+            | Q(application_namespace="")
+        )
+        .values_list("application_namespace", flat=True)
+    )

src/open_inwoner/components/templates/components/UserFeed/UserFeed.html

@@ -216,6 +216,7 @@
     "open_inwoner.extended_sessions",
     "open_inwoner.custom_csp",
     "open_inwoner.media",
+    "open_inwoner.userfeed",
     "open_inwoner.cms.profile",
     "open_inwoner.cms.cases",
     "open_inwoner.cms.inbox",
@@ -553,6 +554,7 @@
             "QuestionnairePlugin",
             "ProductFinderPlugin",
             "ProductLocationPlugin",
+            "UserFeedPlugin",
         ],
         "text_only_plugins": ["LinkPlugin"],
         "name": _("Content"),

src/open_inwoner/conf/base.py

@@ -44,6 +44,8 @@
 from open_inwoner.utils.logentry import system_action as log_system_action
 from open_inwoner.utils.url import build_absolute_url
 
+from ..userfeed.hooks.case_document import case_document_added_notification_received
+from ..userfeed.hooks.case_status import case_status_notification_received
 from .models import ZaakTypeStatusTypeConfig
 
 logger = logging.getLogger(__name__)
@@ -215,6 +217,9 @@ def _handle_zaakinformatieobject_notification(
 def handle_zaakinformatieobject_update(
     user: User, case: Zaak, zaak_info_object: ZaakInformatieObject
 ):
+    # hook into userfeed
+    case_document_added_notification_received(user, case, zaak_info_object)
+
     note = UserCaseInfoObjectNotification.objects.record_if_unique_notification(
         user,
         case.uuid,
@@ -344,6 +349,10 @@ def _handle_status_notification(notification: Notification, case: Zaak, inform_u
 
 
 def handle_status_update(user: User, case: Zaak, status: Status):
+    # hook into userfeed
+    case_status_notification_received(user, case, status)
+
+    # email notification
     note = UserCaseStatusNotification.objects.record_if_unique_notification(
         user,
         case.uuid,

src/open_inwoner/openzaak/notifications.py

@@ -1,5 +1,5 @@
 import datetime
-from unittest.mock import patch
+from unittest.mock import Mock, patch
 
 from django.conf import settings
 from django.contrib.auth.models import AnonymousUser
@@ -585,7 +585,11 @@ def _setUpMocks(self, m, use_eindstatus=True):
             ),
         )
 
-    def test_status_is_retrieved_when_user_logged_in_via_digid(self, m):
+    @patch("open_inwoner.cms.cases.views.status.case_status_seen")
+    @patch("open_inwoner.cms.cases.views.status.case_documents_seen")
+    def test_status_is_retrieved_when_user_logged_in_via_digid(
+        self, m, mock_hook_status: Mock, mock_hook_documents: Mock
+    ):
         self.maxDiff = None
 
         ZaakTypeStatusTypeConfigFactory.create(
@@ -663,6 +667,9 @@ def test_status_is_retrieved_when_user_logged_in_via_digid(self, m):
                 "new_docs": False,
             },
         )
+        # check userfeed hooks
+        mock_hook_status.assert_called_once()
+        mock_hook_documents.assert_called_once()
 
     def test_pass_endstatus_type_data_if_endstatus_not_reached(self, m):
         self.maxDiff = None

src/open_inwoner/openzaak/tests/test_case_detail.py

@@ -124,6 +124,22 @@ def __init__(self):
             zaak=self.zaak["url"],
         )
 
+        self.informatie_object_extra = generate_oas_component(
+            "drc",
+            "schemas/EnkelvoudigInformatieObject",
+            url=f"{DOCUMENTEN_ROOT}enkelvoudiginformatieobjecten/aaaaaaaa-0002-bbbb-aaaa-aaaaaaaaaaaa",
+            informatieobjecttype=f"{CATALOGI_ROOT}informatieobjecttypen/aaaaaaaa-aaaa-aaaa-aaaa-aaaaaaaaaaaa",
+            status="definitief",
+            vertrouwelijkheidaanduiding=VertrouwelijkheidsAanduidingen.openbaar,
+        )
+        self.zaak_informatie_object_extra = generate_oas_component(
+            "zrc",
+            "schemas/ZaakInformatieObject",
+            url=f"{ZAKEN_ROOT}zaakinformatieobjecten/aaaaaaaa-0002-aaaa-aaaa-aaaaaaaaaaaa",
+            informatieobject=self.informatie_object_extra["url"],
+            zaak=self.zaak["url"],
+        )
+
         self.role_initiator = generate_oas_component(
             "zrc",
             "schemas/Rol",
@@ -190,6 +206,8 @@ def install_mocks(self, m, *, res404: Optional[List[str]] = None) -> "MockAPIDat
             "status_type_final",
             "informatie_object",
             "zaak_informatie_object",
+            "informatie_object_extra",
+            "zaak_informatie_object_extra",
         ]:
             resource = getattr(self, resource_attr)
             if resource_attr in res404:

src/open_inwoner/openzaak/tests/test_notification_data.py

@@ -301,9 +301,14 @@ def test_zio_bails_when_zaak_type_info_object_type_config_is_found_not_marked_fo
 
 @override_settings(ZGW_LIMIT_NOTIFICATIONS_FREQUENCY=3600)
 @freeze_time("2023-01-01 01:00:00")
-class NotificationHandlerEmailTestCase(AssertTimelineLogMixin, TestCase):
+class NotificationHandlerUserMessageTestCase(AssertTimelineLogMixin, TestCase):
+    @patch(
+        "open_inwoner.openzaak.notifications.case_document_added_notification_received"
+    )
     @patch("open_inwoner.openzaak.notifications.send_case_update_email")
-    def test_handle_zaak_info_object_update(self, mock_send: Mock):
+    def test_handle_zaak_info_object_update(
+        self, mock_send: Mock, mock_feed_hook: Mock
+    ):
         """
         note this test matches with a similar test from `test_notification_zaak_status.py`
         """
@@ -321,6 +326,9 @@ def test_handle_zaak_info_object_update(self, mock_send: Mock):
 
         mock_send.assert_called_once()
 
+        # check if userfeed hook was called
+        mock_feed_hook.assert_called_once()
+
         # check call arguments
         args = mock_send.call_args.args
         self.assertEqual(args[0], user)

src/open_inwoner/openzaak/tests/test_notification_zaak_infoobject.py

@@ -472,9 +472,10 @@ def test_status_bails_when_skip_informeren_is_set_and_zaaktypeconfig_is_not_foun
 
 @override_settings(ZGW_LIMIT_NOTIFICATIONS_FREQUENCY=3600)
 @freeze_time("2023-01-01 01:00:00")
-class NotificationHandlerEmailTestCase(AssertTimelineLogMixin, TestCase):
+class NotificationHandlerUserMessageTestCase(AssertTimelineLogMixin, TestCase):
+    @patch("open_inwoner.openzaak.notifications.case_status_notification_received")
     @patch("open_inwoner.openzaak.notifications.send_case_update_email")
-    def test_handle_status_update(self, mock_send: Mock):
+    def test_handle_status_update(self, mock_send: Mock, mock_feed_hook: Mock):
         """
         note this test matches with a similar test from `test_notification_zaak_infoobject.py`
         """
@@ -492,6 +493,9 @@ def test_handle_status_update(self, mock_send: Mock):
 
         mock_send.assert_called_once()
 
+        # check if userfeed hook was called
+        mock_feed_hook.assert_called_once()
+
         # check call arguments
         args = mock_send.call_args.args
         self.assertEqual(args[0], user)