From c24cb2b74d3408277c6fed627eb8f5d0bb23c2fe Mon Sep 17 00:00:00 2001 From: vasileios Date: Wed, 22 Jan 2025 15:28:26 +0100 Subject: [PATCH] [#5006] Updated AddressValueSerializer to adapt manual filling of streetname and city Updated street name and city serializer fields in order to be able to require these fields in case the component is required. --- src/openforms/contrib/brk/constants.py | 1 + src/openforms/formio/components/custom.py | 37 ++++++++- src/openforms/formio/formatters/custom.py | 1 + .../formio/tests/validation/test_addressnl.py | 79 ++++++++++++++++++- .../tests/e2e/test_input_validation.py | 10 ++- 5 files changed, 120 insertions(+), 8 deletions(-) diff --git a/src/openforms/contrib/brk/constants.py b/src/openforms/contrib/brk/constants.py index 9fef1d3f96..493ade886a 100644 --- a/src/openforms/contrib/brk/constants.py +++ b/src/openforms/contrib/brk/constants.py @@ -9,3 +9,4 @@ class AddressValue(TypedDict): city: NotRequired[str] streetName: NotRequired[str] secretStreetCity: NotRequired[str] + autoPopulated: NotRequired[bool] diff --git a/src/openforms/formio/components/custom.py b/src/openforms/formio/components/custom.py index e36f585677..e1e1366167 100644 --- a/src/openforms/formio/components/custom.py +++ b/src/openforms/formio/components/custom.py @@ -425,12 +425,36 @@ class AddressValueSerializer(serializers.Serializer): required=False, allow_blank=True, ) + autoPopulated = serializers.BooleanField( + label=_("city and street name auto populated"), + help_text=_("Whether city and street name have been retrieved from the API"), + default=False, + ) def __init__(self, **kwargs): self.derive_address = kwargs.pop("derive_address", None) self.component = kwargs.pop("component", None) super().__init__(**kwargs) + def get_fields(self): + fields = super().get_fields() + + # Some fields have to be treated as required or not dynamically and based on + # specific situations. + if self.component and (validate := self.component.get("validate")): + if validate["required"] is True: + if self.derive_address: + fields["city"].required = True + fields["city"].allow_blank = False + fields["streetName"].required = True + fields["streetName"].allow_blank = False + elif validate["required"] is False: + fields["postcode"].required = False + fields["postcode"].allow_blank = True + fields["houseNumber"].required = False + fields["houseNumber"].allow_blank = True + return fields + def validate_city(self, value: str) -> str: if city_regex := glom( self.component, "openForms.components.city.validate.pattern", default="" @@ -457,18 +481,23 @@ def validate_postcode(self, value: str) -> str: def validate(self, attrs): attrs = super().validate(attrs) + auto_populated = attrs.get("autoPopulated", False) + postcode = attrs.get("postcode", "") + house_number = attrs.get("houseNumber", "") city = attrs.get("city", "") street_name = attrs.get("streetName", "") if self.derive_address: - existing_hmac = attrs.get("secretStreetCity", "") - postcode = attrs.get("postcode", "") - number = attrs.get("houseNumber", "") + # when the user fills in manually the city and the street name we do not + # need to check the secret city - street name combination + if not auto_populated: + return attrs + existing_hmac = attrs.get("secretStreetCity", "") computed_hmac = salt_location_message( { "postcode": postcode, - "number": number, + "number": house_number, "city": city, "street_name": street_name, } diff --git a/src/openforms/formio/formatters/custom.py b/src/openforms/formio/formatters/custom.py index 6c87744fc9..ce5d0f1963 100644 --- a/src/openforms/formio/formatters/custom.py +++ b/src/openforms/formio/formatters/custom.py @@ -42,6 +42,7 @@ class AddressValue(TypedDict): city: NotRequired[str] streetName: NotRequired[str] secretStreetCity: NotRequired[str] + autoPopulated: NotRequired[bool] class AddressNLFormatter(FormatterBase): diff --git a/src/openforms/formio/tests/validation/test_addressnl.py b/src/openforms/formio/tests/validation/test_addressnl.py index 365dd49a83..960995de47 100644 --- a/src/openforms/formio/tests/validation/test_addressnl.py +++ b/src/openforms/formio/tests/validation/test_addressnl.py @@ -106,12 +106,51 @@ def test_addressNL_field_regex_pattern_success(self): self.assertTrue(is_valid) - def test_missing_keys(self): + def test_missing_keys_when_component_optional(self): component: AddressNLComponent = { "key": "addressNl", "type": "addressNL", "label": "AddressNL missing keys", "deriveAddress": False, + "validate": {"required": False}, + } + + data = { + "addressNl": { + "houseLetter": "A", + } + } + + is_valid, _ = validate_formio_data(component, data) + + self.assertTrue(is_valid) + + def test_missing_keys_when_autofill_and_component_optional(self): + component: AddressNLComponent = { + "key": "addressNl", + "type": "addressNL", + "label": "AddressNL missing keys", + "deriveAddress": True, + "validate": {"required": False}, + } + + data = { + "addressNl": { + "houseLetter": "A", + } + } + + is_valid, _ = validate_formio_data(component, data) + + self.assertTrue(is_valid) + + def test_missing_keys_when_component_required(self): + component: AddressNLComponent = { + "key": "addressNl", + "type": "addressNL", + "label": "AddressNL missing keys", + "deriveAddress": True, + "validate": {"required": True}, } invalid_values = { @@ -124,10 +163,14 @@ def test_missing_keys(self): postcode_error = extract_error(errors["addressNl"], "postcode") house_number_error = extract_error(errors["addressNl"], "houseNumber") + street_name_error = extract_error(errors["addressNl"], "streetName") + city_error = extract_error(errors["addressNl"], "city") self.assertFalse(is_valid) self.assertEqual(postcode_error.code, "required") self.assertEqual(house_number_error.code, "required") + self.assertEqual(street_name_error.code, "required") + self.assertEqual(city_error.code, "required") def test_plugin_validator(self): with replace_validators_registry() as register: @@ -138,7 +181,7 @@ def test_plugin_validator(self): "type": "addressNL", "label": "AddressNL plugin validator", "deriveAddress": False, - "validate": {"plugins": ["postcode_validator"]}, + "validate": {"required": False, "plugins": ["postcode_validator"]}, } with self.subTest("valid value"): @@ -150,6 +193,8 @@ def test_plugin_validator(self): "houseNumber": "3", "houseLetter": "A", "houseNumberAddition": "", + "streetName": "Keizersgracht", + "city": "Amsterdam", } }, ) @@ -176,7 +221,7 @@ def test_addressNL_field_secret_success(self): "key": "addressNl", "type": "addressNL", "label": "AddressNL secret success", - "deriveAddress": False, + "deriveAddress": True, } message = "1015CJ/117/Amsterdam/Keizersgracht" @@ -190,6 +235,7 @@ def test_addressNL_field_secret_success(self): "city": "Amsterdam", "streetName": "Keizersgracht", "secretStreetCity": secret, + "autoPopulated": True, } } @@ -214,6 +260,7 @@ def test_addressNL_field_secret_failure(self): "city": "Amsterdam", "streetName": "Keizersgracht", "secretStreetCity": "invalid secret", + "autoPopulated": True, } } @@ -224,6 +271,32 @@ def test_addressNL_field_secret_failure(self): self.assertFalse(is_valid) self.assertEqual(secret_error.code, "invalid") + def test_addressNL_field_secret_not_used_when_manual_address(self): + component: AddressNLComponent = { + "key": "addressNl", + "type": "addressNL", + "label": "AddressNL secret failure", + "deriveAddress": True, + "validate": {"required": False}, + } + + data = { + "addressNl": { + "postcode": "1015CJ", + "houseNumber": "117", + "houseLetter": "", + "houseNumberAddition": "", + "city": "Amsterdam", + "streetName": "Keizersgracht", + "secretStreetCity": "a secret", + "autoPopulated": False, + } + } + + is_valid, _ = validate_formio_data(component, data) + + self.assertTrue(is_valid) + def test_addressNL_field_missing_city(self): component: AddressNLComponent = { "key": "addressNl", diff --git a/src/openforms/tests/e2e/test_input_validation.py b/src/openforms/tests/e2e/test_input_validation.py index 0deb90fa9a..ec8e8de228 100644 --- a/src/openforms/tests/e2e/test_input_validation.py +++ b/src/openforms/tests/e2e/test_input_validation.py @@ -979,6 +979,7 @@ def assertAddressNLValidationIsAligned( ui_inputs: dict[str, str], expected_ui_error: str, api_value: dict[str, Any], + expected_error_keys: list[str] = [], ) -> None: form = create_form(component) @@ -986,7 +987,13 @@ def assertAddressNLValidationIsAligned( self._assertAddressNLFrontendValidation(form, ui_inputs, expected_ui_error) with self.subTest("backend validation"): - self._assertBackendValidation(form, component["key"], api_value) + if not expected_error_keys: + self._assertBackendValidation(form, component["key"], api_value) + else: + for key in expected_error_keys: + self._assertBackendValidation( + form, f"{component['key']}.{key}", api_value + ) @async_to_sync async def _assertAddressNLFrontendValidation( @@ -1026,6 +1033,7 @@ def test_required_field(self): "houseLetter": "", "houseNumberAddition": "", }, + expected_error_keys=["postcode", "houseNumber"], expected_ui_error="Het verplichte veld Required AddressNL is niet ingevuld.", )