Skip to content

Commit

Permalink
🐛 [#3901] Fix submissions incorrectly expecting cosigning
Browse files Browse the repository at this point in the history
When cosign components are (dynamically) hidden, this effectively makes
the form/submission *not* a cosign form. However, due to logic not
being taken into account, the mere presence of a required cosign
component would block the registration by waiting for cosign.
  • Loading branch information
sergei-maertens committed Dec 10, 2024
1 parent 48b6d3b commit 3bd0286
Show file tree
Hide file tree
Showing 2 changed files with 69 additions and 1 deletion.
17 changes: 17 additions & 0 deletions src/openforms/submissions/cosigning.py
Original file line number Diff line number Diff line change
Expand Up @@ -87,13 +87,30 @@ def _find_component(self) -> Component | None:
"""
Discover the Formio cosign component in the submission/form.
"""
from .form_logic import check_submission_logic
from .logic.datastructures import DataContainer

check_submission_logic(self.submission)

# use the complete view on the Formio component tree(s)
configuration_wrapper = self.submission.total_configuration_wrapper

# there should only be one cosign component, so we check our flatmap to find the
# component.
for component in configuration_wrapper.component_map.values():
if component["type"] == "cosign":
# we can't just blindly return the component, as it may be conditionally
# displayed, which is equivalent to "cosign not relevant". See
# https://github.com/open-formulieren/open-forms/issues/3901
container = DataContainer(
self.submission.load_submission_value_variables_state()
)
visible = configuration_wrapper.is_visible_in_frontend(
component["key"],
values=container.data,
)
if not visible:
return None
return component
return None

Expand Down
53 changes: 52 additions & 1 deletion src/openforms/submissions/tests/test_post_submission_event.py
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,8 @@
from openforms.authentication.service import AuthAttribute
from openforms.config.models import GlobalConfiguration
from openforms.emails.tests.factories import ConfirmationEmailTemplateFactory
from openforms.forms.tests.factories import FormDefinitionFactory
from openforms.forms.constants import LogicActionTypes, PropertyTypes
from openforms.forms.tests.factories import FormDefinitionFactory, FormLogicFactory
from openforms.payments.constants import PaymentStatus
from openforms.payments.tests.factories import SubmissionPaymentFactory
from openforms.registrations.base import PreRegistrationResult
Expand Down Expand Up @@ -1027,6 +1028,56 @@ def test_cosign_required_but_hidden_proceeds_with_registration(self):
submission.refresh_from_db()
self.assertEqual(submission.registration_status, RegistrationStatuses.success)

@tag("gh-3901", "hlmr-86")
def test_cosign_required_and_visible_via_logic_does_not_proceed_with_registration(
self,
):
"""
A conditionally displayed cosign component must block registration.
"""
submission = SubmissionFactory.from_components(
components_list=[
{
"key": "cosign",
"type": "cosign",
"label": "Cosign component",
"validate": {"required": True},
"hidden": True,
},
],
submitted_data={"cosign": ""},
completed=True,
cosign_complete=False,
form__registration_backend="email",
form__registration_backend_options={"to_emails": ["[email protected]"]},
auth_info__attribute=AuthAttribute.bsn,
auth_info__value="111222333",
language_code="en",
)
FormLogicFactory.create(
form=submission.form,
json_logic_trigger=True,
actions=[
{
"action": {
"type": LogicActionTypes.property,
"property": {
"type": PropertyTypes.bool,
"value": "hidden",
},
"state": False,
},
"component": "cosign",
}
],
)
assert submission.registration_status == RegistrationStatuses.pending

on_post_submission_event(submission.pk, PostSubmissionEvents.on_completion)

submission.refresh_from_db()
self.assertEqual(submission.registration_status, RegistrationStatuses.pending)

@tag("gh-3924")
def test_payment_complete_does_not_set_retry_flag(self):
submission = SubmissionFactory.create(
Expand Down

0 comments on commit 3bd0286

Please sign in to comment.