Merge pull request #3820 from open-formulieren/feature/3680-remove-auth-plugin-from-cosign

Feature/3680 remove auth plugin from cosign

Author: sergei-maertens

package-lock.json

@@ -29,7 +29,7 @@
   "dependencies": {
     "@fortawesome/fontawesome-free": "^6.1.1",
     "@open-formulieren/design-tokens": "^0.51.0",
-    "@open-formulieren/formio-builder": "^0.14.2",
+    "@open-formulieren/formio-builder": "^0.15.1",
     "@open-formulieren/leaflet-tools": "^1.0.0",
     "@rjsf/core": "^4.2.1",
     "@tinymce/tinymce-react": "^4.3.2",

package.json

@@ -7061,10 +7061,16 @@ components:
         hideNonApplicableSteps:
           type: boolean
           readOnly: true
+        cosignLoginOptions:
+          type: array
+          items:
+            $ref: '#/components/schemas/LoginOption'
+          readOnly: true
         cosignLoginInfo:
           allOf:
           - $ref: '#/components/schemas/CosignLoginInfo'
           readOnly: true
+          deprecated: true
         submissionStatementsConfiguration:
           type: array
           items:
@@ -7102,6 +7108,7 @@ components:
           nullable: true
       required:
       - cosignLoginInfo
+      - cosignLoginOptions
       - hideNonApplicableSteps
       - loginOptions
       - loginRequired
@@ -8619,10 +8626,16 @@ components:
         hideNonApplicableSteps:
           type: boolean
           readOnly: true
+        cosignLoginOptions:
+          type: array
+          items:
+            $ref: '#/components/schemas/LoginOption'
+          readOnly: true
         cosignLoginInfo:
           allOf:
           - $ref: '#/components/schemas/CosignLoginInfo'
           readOnly: true
+          deprecated: true
         submissionStatementsConfiguration:
           type: array
           items:

src/openapi.yaml

@@ -11,16 +11,19 @@ class LoginOptionsReadOnlyField(serializers.ListField):
     there is no write-mode support because this data is not writable
     """
 
-    def __init__(self, *args, **kwargs):
+    def __init__(self, is_for_cosign: bool = False, *args, **kwargs) -> None:
         kwargs.setdefault("child", LoginOptionSerializer())
         kwargs["read_only"] = True
         kwargs["source"] = "*"
+
+        self.is_for_cosign = is_for_cosign
+
         super().__init__(*args, **kwargs)
 
     def to_internal_value(self, data):
         raise NotImplementedError("read only")
 
     def to_representation(self, form):
         request = self.context["request"]
-        temp = auth_register.get_options(request, form)
+        temp = auth_register.get_options(request, form, self.is_for_cosign)
         return super().to_representation(temp)

src/openforms/authentication/api/fields.py

@@ -1,11 +1,14 @@
 from django.utils.translation import gettext_lazy as _
 
+from furl import furl
 from rest_framework import serializers
+from rest_framework.reverse import reverse
 
+from openforms.authentication.base import LoginInfo
+from openforms.authentication.registry import register as auth_register
 from openforms.plugins.api.serializers import PluginBaseSerializer
 
 from ..constants import LogoAppearance
-from ..utils import get_cosign_login_info
 
 
 class TextChoiceSerializer(serializers.Serializer):
@@ -83,4 +86,32 @@ class LoginOptionSerializer(serializers.Serializer):
 
 class CosignLoginInfoSerializer(LoginOptionSerializer):
     def get_attribute(self, form):
-        return get_cosign_login_info(self.context["request"], form)
+        if not form.cosign_component:
+            return None
+
+        auth_plugin_id = form.authentication_backends[0]
+        auth_url = reverse(
+            "authentication:start",
+            kwargs={
+                "slug": form.slug,
+                "plugin_id": auth_plugin_id,
+            },
+            request=self.context["request"],
+        )
+        next_url = reverse(
+            "submissions:find-submission-for-cosign",
+            kwargs={"form_slug": form.slug},
+            request=self.context["request"],
+        )
+        auth_page = furl(auth_url)
+        auth_page.args.set("next", next_url)
+
+        auth_plugin = auth_register[auth_plugin_id]
+
+        return LoginInfo(
+            auth_plugin.identifier,
+            auth_plugin.get_label(),
+            url=auth_page.url,
+            logo=auth_plugin.get_logo(self.context["request"]),
+            is_for_gemachtigde=auth_plugin.is_for_gemachtigde,
+        )

src/openforms/authentication/api/serializers.py

@@ -12,6 +12,7 @@
 from openforms.typing import AnyRequest
 
 from .constants import AuthAttribute
+from .utils import get_cosign_login_url
 
 
 @dataclass()
@@ -98,11 +99,18 @@ def logout(self, request: HttpRequest):
         """
         pass
 
-    def get_login_info(self, request: HttpRequest, form: Form | None) -> LoginInfo:
+    def get_login_info(
+        self, request: HttpRequest, form: Form | None, is_for_cosign: bool = False
+    ) -> LoginInfo:
+        if is_for_cosign:
+            login_url = get_cosign_login_url(request, form, self.identifier)
+        else:
+            login_url = self.get_start_url(request, form) if form else ""
+
         info = LoginInfo(
             self.identifier,
             self.get_label(),
-            url=self.get_start_url(request, form) if form else "",
+            url=login_url,
             logo=self.get_logo(request),
             is_for_gemachtigde=self.is_for_gemachtigde,
         )

src/openforms/authentication/base.py

@@ -31,9 +31,15 @@ class Registry(BaseRegistry["BasePlugin"]):
     module = "authentication"
 
     def get_options(
-        self, request: HttpRequest, form: Form | None = None
-    ) -> list[LoginInfo]:
+        self,
+        request: HttpRequest,
+        form: Form | None = None,
+        is_for_cosign: bool = False,
+    ) -> list["LoginInfo"]:
         options = list()
+        if is_for_cosign and (not form or not form.cosign_component):
+            return options
+
         for plugin_id in _iter_plugin_ids(form, self):
             if plugin_id not in self._registry:
                 logger.warning(
@@ -43,7 +49,7 @@ def get_options(
                 )
                 continue
             plugin = self._registry[plugin_id]
-            info = plugin.get_login_info(request, form)
+            info = plugin.get_login_info(request, form, is_for_cosign)
             options.append(info)
         return options
 

src/openforms/authentication/registry.py

@@ -6,7 +6,7 @@
 from openforms.forms.tests.factories import FormStepFactory
 from openforms.submissions.tests.factories import SubmissionFactory
 
-from ..utils import get_cosign_login_info, store_auth_details, store_registrator_details
+from ..utils import get_cosign_login_url, store_auth_details, store_registrator_details
 
 
 class UtilsTests(TestCase):
@@ -28,22 +28,6 @@ def test_store_registrator_details(self):
                 {"plugin": "digid", "attribute": "WRONG", "value": "some-value"},
             )
 
-    def test_get_cosign_info_when_no_cosign_on_form(self):
-        form_step = FormStepFactory.create(
-            form_definition__configuration={
-                "components": [
-                    {"key": "textField", "label": "Not cosign", "type": "textfield"}
-                ]
-            }
-        )
-
-        factory = RequestFactory()
-        request = factory.get("/foo")
-
-        login_info = get_cosign_login_info(request=request, form=form_step.form)
-
-        self.assertIsNone(login_info)
-
     def test_get_cosign_info(self):
         form_step = FormStepFactory.create(
             form__slug="form-with-cosign",
@@ -62,11 +46,11 @@ def test_get_cosign_info(self):
         factory = RequestFactory()
         request = factory.get("/foo")
 
-        login_info = get_cosign_login_info(request=request, form=form_step.form)
-
-        self.assertIsNotNone(login_info)
+        login_url = get_cosign_login_url(
+            request=request, form=form_step.form, plugin_id="digid"
+        )
+        login_url = furl(login_url)
 
-        login_url = furl(login_info.url)
         submission_find_url = furl(
             login_url.args["next"]
         )  # Page where the user will look for the submission to cosign

src/openforms/authentication/tests/test_utils.py

@@ -7,7 +7,6 @@
 from openforms.forms.models import Form
 from openforms.submissions.models import Submission
 
-from .base import LoginInfo
 from .constants import FORM_AUTH_SESSION_KEY, AuthAttribute
 from .models import AuthInfo, RegistratorInfo
 from .registry import register as auth_register
@@ -68,15 +67,12 @@ def meets_plugin_requirements(request: Request, config: dict) -> bool:
     return plugin.check_requirements(request, config.get(plugin_id, {}))
 
 
-def get_cosign_login_info(request: Request, form: Form) -> LoginInfo | None:
-    if not (co_sign_component := form.get_cosign_component()):
-        return None
-
+def get_cosign_login_url(request: Request, form: Form, plugin_id: str) -> str:
     auth_url = reverse(
         "authentication:start",
         kwargs={
             "slug": form.slug,
-            "plugin_id": co_sign_component["authPlugin"],
+            "plugin_id": plugin_id,
         },
         request=request,
     )
@@ -87,14 +83,4 @@ def get_cosign_login_info(request: Request, form: Form) -> LoginInfo | None:
     )
     auth_page = furl(auth_url)
     auth_page.args.set("next", next_url)
-
-    auth_plugin_id = co_sign_component["authPlugin"]
-    auth_plugin = auth_register[auth_plugin_id]
-
-    return LoginInfo(
-        auth_plugin.identifier,
-        auth_plugin.get_label(),
-        url=auth_page.url,
-        logo=auth_plugin.get_logo(request),
-        is_for_gemachtigde=auth_plugin.is_for_gemachtigde,
-    )
+    return auth_page.url

src/openforms/authentication/utils.py

@@ -7,7 +7,7 @@
 """
 
 from .base import Component, OptionDict
-from .custom import CosignComponent, DateComponent
+from .custom import DateComponent
 from .vanilla import (
     Column,
     ColumnsComponent,
@@ -30,6 +30,5 @@
     "Column",
     "ColumnsComponent",
     "DatetimeComponent",
-    "CosignComponent",
     "DateComponent",
 ]

src/openforms/formio/typing/__init__.py

@@ -2,9 +2,5 @@
 from .dates import DatePickerConfig
 
 
-class CosignComponent(Component):
-    authPlugin: str
-
-
 class DateComponent(Component):
     datePicker: DatePickerConfig | None

src/openforms/formio/typing/custom.py

@@ -96,7 +96,11 @@ def validate(self, attrs):
 
 
 @extend_schema_serializer(
-    deprecate_fields=["registration_backend", "registration_backend_options"]
+    deprecate_fields=[
+        "registration_backend",
+        "registration_backend_options",
+        "cosign_login_info",
+    ]
 )
 class FormSerializer(PublicFieldsSerializerMixin, serializers.ModelSerializer):
     """
@@ -120,6 +124,8 @@ class FormSerializer(PublicFieldsSerializerMixin, serializers.ModelSerializer):
     )
     authentication_backend_options = serializers.DictField(required=False, default=dict)
     login_options = LoginOptionsReadOnlyField()
+    cosign_login_options = LoginOptionsReadOnlyField(is_for_cosign=True)
+    # TODO: deprecated, remove in 3.0.0
     cosign_login_info = CosignLoginInfoSerializer(source="*", read_only=True)
     auto_login_authentication_backend = serializers.CharField(
         required=False,
@@ -262,6 +268,7 @@ class Meta:
             "translations",
             "resume_link_lifetime",
             "hide_non_applicable_steps",
+            "cosign_login_options",
             "cosign_login_info",
             "submission_statements_configuration",
             "submission_report_download_link_title",
@@ -292,6 +299,7 @@ class Meta:
             "appointment_options",
             "resume_link_lifetime",
             "hide_non_applicable_steps",
+            "cosign_login_options",
             "cosign_login_info",
             "submission_statements_configuration",
             "submission_report_download_link_title",