[#3362] PR feedback

docs/developers/backend/core/testing-tools.rst

@@ -13,6 +13,12 @@ HTML assertions
 .. automodule:: openforms.utils.tests.webtest_base
    :members:
 
+Frontend redirects
+==================
+
+.. automodule:: openforms.frontend.tests
+   :members:
+
 Migrations
 ==========
 

docs/developers/sdk/embedding.rst

@@ -71,6 +71,10 @@ Available options
     would be ``https://example.com/basepath?cms_query=1#/startpagina`` (SDK specific query parameters would come
     at the end of the URL).
 
+    .. warning::
+        This is a last resort solution - preferably the backend where you embed the form would set up "wildcard" routes to
+        ensure that refreshing the page works, e.g. ``/some-path/<form-id>/*`` should just load the CMS page for a specific form.
+
 ``CSPNonce``:
     Recommended. The page's CSP Nonce value if inline styles are blocked by your
     `Content Security Policy <https://content-security-policy.com/nonce/>`_. The Open

src/openforms/appointments/tests/test_views.py

@@ -11,6 +11,7 @@
 from openforms.authentication.constants import FORM_AUTH_SESSION_KEY, AuthAttribute
 from openforms.authentication.contrib.digid.constants import DIGID_DEFAULT_LOA
 from openforms.forms.tests.factories import FormFactory
+from openforms.frontend.tests import FrontendRedirectMixin
 from openforms.logging.models import TimelineLogProxy
 from openforms.payments.constants import PaymentStatus
 from openforms.payments.tests.factories import SubmissionPaymentFactory
@@ -20,14 +21,13 @@
     SubmissionFactory,
     SubmissionStepFactory,
 )
-from openforms.tests.mixins import FrontendRedirectMixin
 
 from ..tokens import submission_appointment_token_generator
 from .factories import AppointmentFactory, AppointmentInfoFactory
 
 
 @freeze_time("2021-07-15T21:15:00Z")
-class VerifyCancelAppointmentLinkViewTests(TestCase, FrontendRedirectMixin):
+class VerifyCancelAppointmentLinkViewTests(FrontendRedirectMixin, TestCase):
     def test_good_token_and_submission_redirect_and_add_submission_to_session(self):
         submission = SubmissionFactory.create(
             completed=True, form_url="http://maykinmedia.nl/myform"
@@ -341,7 +341,7 @@ def test_invalid_auth_value_raises_exception(self):
 
 
 @freeze_time("2021-07-15T21:15:00Z")
-class VerifyChangeAppointmentLinkViewTests(TestCase, FrontendRedirectMixin):
+class VerifyChangeAppointmentLinkViewTests(FrontendRedirectMixin, TestCase):
     def test_good_token_and_submission_redirect_and_add_submission_to_session(self):
         submission = SubmissionFactory.from_components(
             completed=True,

src/openforms/frontend/__init__.py

@@ -0,0 +1,3 @@
+from .frontend import get_frontend_redirect_url
+
+__all__ = ["get_frontend_redirect_url"]

src/openforms/tests/mixins.py → src/openforms/frontend/tests.py

@@ -6,7 +6,7 @@
 
 from furl import furl
 
-from openforms.frontend import SDKAction
+from .frontend import SDKAction
 
 
 class FrontendRedirectMixin:
@@ -26,7 +26,7 @@ def assertRedirectsToFrontend(
         :param frontend_base_url: The base URL of the frontend.
         :param action: The SDK action performed.
         :param action_params: Optional parameters for the action.
-        :param **kwargs: Additional kwargs to be passed to ``assertRedirects``.
+        :param `**kwargs`: Additional kwargs to be passed to :meth:`django.test.SimpleTestCase.assertRedirects`.
         """
 
         expected_redirect_url = furl(frontend_base_url)

src/openforms/submissions/migrations/0079_cleanup_urls.py → src/openforms/submissions/migrations/0003_cleanup_urls.py

@@ -1,4 +1,5 @@
-# Generated by Django 3.2.21 on 2023-11-16 14:57
+# Generated by Django 3.2.21 on 2023-11-17 10:40
+
 from django.db import migrations
 from django.db.migrations.state import StateApps
 from django.db.backends.base.schema import BaseDatabaseSchemaEditor
@@ -12,9 +13,11 @@ def cleanup_submission_urls(
 
     Submission = apps.get_model("submissions", "Submission")
 
-    for submission in Submission.objects.all():
+    for submission in Submission.objects.iterator():
         f = furl(submission.form_url)
         f.remove(fragment=True)
+        if f.path.segments[-1:] == ["startpagina"]:
+            f.path.segments.remove("startpagina")
         submission.form_url = f.url
 
         submission.save()
@@ -23,7 +26,9 @@ def cleanup_submission_urls(
 class Migration(migrations.Migration):
 
     dependencies = [
-        ("submissions", "0078_submission_finalised_registration_backend_key"),
+        ("submissions", "0002_change_json_encoder"),
     ]
 
-    operations = [migrations.RunPython(cleanup_submission_urls)]
+    operations = [
+        migrations.RunPython(cleanup_submission_urls, migrations.RunPython.noop)
+    ]

src/openforms/submissions/tests/test_resume_form_view.py

@@ -10,14 +10,14 @@
 from openforms.authentication.constants import FORM_AUTH_SESSION_KEY, AuthAttribute
 from openforms.authentication.contrib.digid.constants import DIGID_DEFAULT_LOA
 from openforms.config.models import GlobalConfiguration
-from openforms.tests.mixins import FrontendRedirectMixin
+from openforms.frontend.tests import FrontendRedirectMixin
 
 from ..constants import SUBMISSIONS_SESSION_KEY
 from ..tokens import submission_resume_token_generator
 from .factories import SubmissionFactory, SubmissionStepFactory
 
 
-class SubmissionResumeViewTests(TestCase, FrontendRedirectMixin):
+class SubmissionResumeViewTests(FrontendRedirectMixin, TestCase):
     def test_good_token_and_submission_redirect_and_add_submission_to_session(self):
         submission = SubmissionFactory.from_components(
             completed=True,

src/openforms/submissions/tests/test_views.py

@@ -6,11 +6,11 @@
 
 from openforms.authentication.constants import FORM_AUTH_SESSION_KEY
 from openforms.authentication.contrib.digid.constants import DIGID_DEFAULT_LOA
+from openforms.frontend.tests import FrontendRedirectMixin
 from openforms.submissions.tests.factories import SubmissionFactory
-from openforms.tests.mixins import FrontendRedirectMixin
 
 
-class SearchSubmissionForCosignView(WebTest, FrontendRedirectMixin):
+class SearchSubmissionForCosignView(FrontendRedirectMixin, WebTest):
     def setUp(self) -> None:
         super().setUp()
 

src/openforms/tests/test_frontend_utils.py

@@ -26,7 +26,7 @@ def test_frontend_redirect_no_hash(self):
         excpected_redirect_url.add(
             {
                 "_of_action": "resume",
-                "_of_action_params": (json.dumps(action_params)),
+                "_of_action_params": json.dumps(action_params),
             }
         )
 
@@ -52,7 +52,7 @@ def test_frontend_redirect_hash(self):
         excpected_redirect_url.add(
             {
                 "_of_action": "resume",
-                "_of_action_params": (json.dumps(action_params)),
+                "_of_action_params": json.dumps(action_params),
             }
         )
 
@@ -78,7 +78,7 @@ def test_frontend_redirect_special_chars(self):
         excpected_redirect_url.add(
             {
                 "_of_action": "resume",
-                "_of_action_params": (json.dumps(action_params)),
+                "_of_action_params": json.dumps(action_params),
             }
         )
 
@@ -104,7 +104,7 @@ def test_frontend_redirect_query_param(self):
         excpected_redirect_url.add(
             {
                 "_of_action": "resume",
-                "_of_action_params": (json.dumps(action_params)),
+                "_of_action_params": json.dumps(action_params),
                 "unrelated_query": "1",
             }
         )