Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[#5006] Ability to manually fill in addressNL streetname and city #5022

Draft
wants to merge 1 commit into
base: master
Choose a base branch
from
Draft

[#5006] Ability to manually fill in addressNL streetname and city #5022

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions src/openforms/contrib/brk/constants.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -9,3 +9,4 @@ class AddressValue(TypedDict):
city: NotRequired[str]
streetName: NotRequired[str]
secretStreetCity: NotRequired[str]
autoPopulated: NotRequired[bool]
37 changes: 33 additions & 4 deletions src/openforms/formio/components/custom.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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=""
Expand All @@ -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
Comment on lines +491 to +494
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

ah okay, and because autoPopulated = False we then also know in the registration backend that the data can potentially not be trusted, right?


existing_hmac = attrs.get("secretStreetCity", "")
computed_hmac = salt_location_message(
{
"postcode": postcode,
"number": number,
"number": house_number,
"city": city,
"street_name": street_name,
}
Expand Down
1 change: 1 addition & 0 deletions src/openforms/formio/formatters/custom.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -42,6 +42,7 @@ class AddressValue(TypedDict):
city: NotRequired[str]
streetName: NotRequired[str]
secretStreetCity: NotRequired[str]
autoPopulated: NotRequired[bool]


class AddressNLFormatter(FormatterBase):
Expand Down
79 changes: 76 additions & 3 deletions src/openforms/formio/tests/validation/test_addressnl.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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 = {
Expand All @@ -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:
Expand All @@ -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"):
Expand All @@ -150,6 +193,8 @@ def test_plugin_validator(self):
"houseNumber": "3",
"houseLetter": "A",
"houseNumberAddition": "",
"streetName": "Keizersgracht",
"city": "Amsterdam",
}
},
)
Expand All @@ -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"
Expand All @@ -190,6 +235,7 @@ def test_addressNL_field_secret_success(self):
"city": "Amsterdam",
"streetName": "Keizersgracht",
"secretStreetCity": secret,
"autoPopulated": True,
}
}

Expand All @@ -214,6 +260,7 @@ def test_addressNL_field_secret_failure(self):
"city": "Amsterdam",
"streetName": "Keizersgracht",
"secretStreetCity": "invalid secret",
"autoPopulated": True,
}
}

Expand All @@ -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",
Expand Down
10 changes: 9 additions & 1 deletion src/openforms/tests/e2e/test_input_validation.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -979,14 +979,21 @@ 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)

with self.subTest("frontend validation"):
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(
Expand Down Expand Up @@ -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.",
)

Expand Down
Loading