feat: Add option to display banner, ask for survey

Author: mrmn2

pdfding/e2e/test_users_e2e.py

@@ -1,11 +1,14 @@
+from datetime import datetime, timedelta, timezone
 from unittest.mock import Mock, patch
 
 from allauth.mfa.models import Authenticator
 from allauth.socialaccount.models import SocialAccount
+from django.contrib.auth.models import User
 from django.test import override_settings
 from django.urls import reverse
 from helpers import PdfDingE2ENoLoginTestCase, PdfDingE2ETestCase
 from playwright.sync_api import expect, sync_playwright
+from users.models import NAGGING_INTERVAL_WEEKS
 
 
 class UsersE2ETestCase(PdfDingE2ETestCase):
@@ -252,6 +255,30 @@ def test_header_admin(self):
             self.open(reverse('pdf_overview'), p)
             expect(self.page.get_by_role("banner")).to_contain_text("Admin")
 
+    def test_nagging_banner_needs_nagging(self):
+        self.user.profile.last_time_nagged = datetime.now(tz=timezone.utc) - timedelta(weeks=NAGGING_INTERVAL_WEEKS + 1)
+        self.user.profile.save()
+
+        self.assertTrue(self.user.profile.needs_nagging)
+
+        with sync_playwright() as p:
+            self.open(reverse('pdf_overview'), p)
+            expect(self.page.locator("#nagging_banner")).to_be_visible()
+
+            self.page.locator("#close_nagging_banner").click()
+            expect(self.page.locator("#nagging_banner")).not_to_be_visible()
+
+        changed_user = User.objects.get(id=self.user.id)
+        self.assertFalse(changed_user.profile.needs_nagging)
+
+    def test_nagging_banner_needs_no_nagging(self):
+        self.user.profile.last_time_nagged = datetime.now(tz=timezone.utc) - timedelta(weeks=NAGGING_INTERVAL_WEEKS - 1)
+        self.user.profile.save()
+
+        with sync_playwright() as p:
+            self.open(reverse('pdf_overview'), p)
+            expect(self.page.locator("#nagging_banner")).not_to_be_visible()
+
 
 class UsersLoginE2ETestCase(PdfDingE2ENoLoginTestCase):
     def test_login(self):
@@ -322,7 +349,7 @@ def test_login_demo_mode(self, mock_uuid4, mock_create_demo_user):
 
 
 class EditionE2ETestCase(PdfDingE2ETestCase):
-    @override_settings(SUPPORTER_EDITION=False, DEMO_MODE=True)
+    @override_settings(DEMO_MODE=True)
     def test_demo_mode_sidebar(self):
         with sync_playwright() as p:
             self.open(reverse('home'), p)

pdfding/templates/includes/header.html

@@ -1,7 +1,10 @@
 {% load static %}
 {% load i18n %}
 {# do not remove background as it otherwise sticky will lock strange #}
-<header class="pt-1 md:pt-2 pb-1 md:pb-2 sticky top-0 z-40 bg-slate-50 dark:bg-slate-900">
+<header class="flex flex-col pt-1 md:pt-2 pb-1 md:pb-2 sticky top-0 z-40 bg-slate-50 dark:bg-slate-900">
+    {% if request.user.is_authenticated and request.user.profile.needs_nagging %}
+    {% include 'includes/nagging_banner.html' %}
+    {% endif %}
     <div class="pr-2 pl-2 md:pl-4 md:pr-4 lg:pr-6 flex items-center justify-between">
         <a class="flex items-center gap-x-2 md:pr-4 py-1" href="/">
             <div id="logo_div" class="flex items-center justify-center bg-primary h-8 w-8 rounded-full">

pdfding/templates/includes/nagging_banner.html

@@ -0,0 +1,18 @@
+<div id="nagging_banner" class="flex flex-row justify-between items-center
+            bg-primary px-2 md:px-4 py-2 -mt-1! md:-mt-2! mb-2 text-slate-100">
+  <div class="hidden md:block">
+  </div>
+  <div class="font-semibold">
+    <span class="pr-1">
+      Help us improving PdfDing by filling out the <a class="underline decoration-2" href="https://opnform.com/forms/pdfding-feedback-fdnojn">survey</a>.
+    </span>
+  </div>
+  <div id="close_nagging_banner"
+       hx-post="{% url 'update_last_time_nagged' %}"
+       hx-headers='{"X-CSRFToken": "{{ csrf_token }}"}'
+       class="cursor-pointer hover:text-white">
+    <svg class="w-5 h-5" viewBox="0 0 16 16" fill="none" xmlns="http://www.w3.org/2000/svg">
+      <path d="M14 3.06055L9.06055 8L14 12.9385L12.9395 14L8 9.06055L3.06152 14L2.00098 12.9395L6.93848 8L2 3.06152L3.06055 2.00098L7.99902 6.93945L12.9385 2L14 3.06055Z" fill="currentColor"/>
+    </svg>
+  </div>
+</div>

pdfding/users/migrations/0031_add_nagging.py

@@ -0,0 +1,19 @@
+# Generated by Django 5.2.14 on 2026-06-22 01:48
+
+import users.models
+from django.db import migrations, models
+
+
+class Migration(migrations.Migration):
+
+    dependencies = [
+        ('users', '0030_add_language_adjust_theme_choices'),
+    ]
+
+    operations = [
+        migrations.AddField(
+            model_name='profile',
+            name='last_time_nagged',
+            field=models.DateTimeField(default=users.models.get_last_time_nagged_initial),
+        ),
+    ]

pdfding/users/models.py

@@ -1,3 +1,5 @@
+from datetime import datetime, timedelta, timezone
+
 from django.contrib.auth.models import User
 from django.db import models
 from django.db.models import QuerySet
@@ -11,6 +13,11 @@
 oldest_trans = _('Oldest')
 name_asc_trans = _('Name Asc')
 name_desc_trans = _('Name Desc')
+NAGGING_INTERVAL_WEEKS = 2
+
+
+def get_last_time_nagged_initial():  # pragma: no cover
+    return datetime.now(tz=timezone.utc) - timedelta(weeks=5)
 
 
 class Profile(models.Model):
@@ -88,6 +95,7 @@ class LanguageChoice(models.TextChoices):
     dark_mode = models.CharField(choices=DarkMode.choices, max_length=6, default=DarkMode.DARK)
     layout = models.CharField(choices=LayoutChoice.choices, max_length=7, default=LayoutChoice.COMPACT)
     language = models.CharField(choices=LanguageChoice.choices, max_length=30, default=LanguageChoice.ENGLISH)
+    last_time_nagged = models.DateTimeField(default=get_last_time_nagged_initial)
     pdf_inverted_mode = models.CharField(choices=EnabledChoice.choices, max_length=8, default=EnabledChoice.DISABLED)
     pdf_keep_screen_awake = models.CharField(
         choices=EnabledChoice.choices, max_length=8, default=EnabledChoice.DISABLED
@@ -242,6 +250,18 @@ def language_code(self) -> str:  # pragma: no cover
 
         return language_codes[self.language]
 
+    @property
+    def needs_nagging(self):
+        """
+        Check if a user needs to be nagged. This is used for nagging users to fill out a survey
+        or support PdfDing through donations.
+        """
+
+        if (datetime.now(tz=timezone.utc) - self.last_time_nagged).days > NAGGING_INTERVAL_WEEKS * 7:
+            return True
+        else:
+            return False
+
     def has_access_to_workspace(self, workspace_id: str) -> bool:
         """Check if the profile has access to the specified workspace"""
 

pdfding/users/tests/test_models.py

@@ -1,10 +1,13 @@
+from datetime import datetime, timedelta, timezone
+
 from allauth.mfa.models import Authenticator
 from django.contrib.auth.models import User
 from django.test import TestCase, override_settings
 from pdf.models.collection_models import Collection
 from pdf.models.pdf_models import Pdf
 from pdf.models.shared_models import SharedCollection, SharedPdf
 from pdf.services.workspace_services import create_collection, create_workspace
+from users.models import NAGGING_INTERVAL_WEEKS
 
 
 class TestProfile(TestCase):
@@ -208,3 +211,17 @@ def test_has_access_to_workspace(self):
 
         self.assertTrue(profile.has_access_to_workspace(other_workspace.id))
         self.assertFalse(profile.has_access_to_workspace(other_user.profile.current_workspace_id))
+
+    def test_needs_nagging_needed(self):
+        self.user.profile.last_time_nagged = datetime.now(tz=timezone.utc) - timedelta(
+            weeks=(NAGGING_INTERVAL_WEEKS + 1)
+        )
+        self.user.profile.save()
+
+        self.assertEqual(self.user.profile.needs_nagging, True)
+
+    def test_needs_nagging_not_needed(self):
+        self.user.profile.last_time_nagged = datetime.now(tz=timezone.utc) - timedelta(weeks=NAGGING_INTERVAL_WEEKS - 1)
+        self.user.profile.save()
+
+        self.assertEqual(self.user.profile.needs_nagging, False)

pdfding/users/tests/test_views.py

@@ -1,3 +1,4 @@
+from datetime import datetime, timezone
 from unittest.mock import Mock, patch
 
 from allauth.socialaccount.models import SocialAccount
@@ -282,6 +283,20 @@ def test_open_collapse_tags_post(self):
         changed_user = User.objects.get(id=self.user.id)
         self.assertFalse(changed_user.profile.tags_open)
 
+    def test_update_last_time_nagged_no_htmx(self):
+        response = self.client.post(reverse('update_last_time_nagged'))
+
+        self.assertRedirects(response, reverse('pdf_overview'), status_code=302)
+
+    def test_a_update_last_time_nagged(self):
+        self.assertTrue((datetime.now(timezone.utc) - self.user.profile.last_time_nagged).total_seconds() > 1000)
+
+        headers = {'HTTP_HX-Request': 'true'}
+
+        self.client.post(reverse('update_last_time_nagged'), **headers)
+        changed_user = User.objects.get(id=self.user.id)
+        self.assertTrue((datetime.now(timezone.utc) - changed_user.profile.last_time_nagged).total_seconds() < 0.1)
+
     def test_change_sorting_post_shared_pdf(self):
         self.assertEqual(self.user.profile.shared_pdf_sorting, Profile.SharedPdfSortingChoice.NEWEST)
 

pdfding/users/urls.py

@@ -15,5 +15,6 @@
     path('change_workspace/<workspace_id>', views.ChangeWorkspace.as_view(), name="change_workspace"),
     path('change_collection/<collection_id>', views.ChangeCollection.as_view(), name="change_collection"),
     path('open_collapse_tags', views.OpenCollapseTags.as_view(), name="open_collapse_tags"),
+    path('update_last_time_nagged', views.UpdateLastTimeNagged.as_view(), name="update_last_time_nagged"),
     path('signatures', views.Signatures.as_view(), name="signatures"),
 ]

pdfding/users/views.py

@@ -1,4 +1,5 @@
 import json
+from datetime import datetime, timezone
 from random import randint
 from uuid import uuid4
 
@@ -252,6 +253,23 @@ def post(self, request: HttpRequest):
         return redirect('account_settings')
 
 
+class UpdateLastTimeNagged(View):
+    """View for updating the last time a user was nagged."""
+
+    def post(self, request: HttpRequest):
+        """Update the last time a user was nagged with the current datetime."""
+
+        if request.htmx:  # type: ignore
+            user_profile = request.user.profile  # type: ignore
+            user_profile.last_time_nagged = datetime.now(tz=timezone.utc)
+
+            user_profile.save()
+
+            return HttpResponseClientRefresh()
+
+        return redirect('pdf_overview')
+
+
 class Signatures(View):
     """View for gettings and setting signatures"""