Cannot make city field optional in addresses

[ioweb-gr]

Summary

In our country we have regions but we don't use cities for delivery nor postcodes as we're a small country.

However making the address attributes optional doesn't actually make them optional in the checkout.

The problem lies in \Magento\Customer\Model\Address\Validator\General::checkRequredFields

/**
     * Check fields that are generally required.
     *
     * @param AbstractAddress $address
     * @return array
     * @throws \Zend_Validate_Exception
     */
    private function checkRequredFields(AbstractAddress $address)
    {
        $errors = [];
        if (!\Zend_Validate::is($address->getFirstname(), 'NotEmpty')) {
            $errors[] = __('"%fieldName" is required. Enter and try again.', ['fieldName' => 'firstname']);
        }

        if (!\Zend_Validate::is($address->getLastname(), 'NotEmpty')) {
            $errors[] = __('"%fieldName" is required. Enter and try again.', ['fieldName' => 'lastname']);
        }

        if (!\Zend_Validate::is($address->getStreetLine(1), 'NotEmpty')) {
            $errors[] = __('"%fieldName" is required. Enter and try again.', ['fieldName' => 'street']);
        }

        if (!\Zend_Validate::is($address->getCity(), 'NotEmpty')) {
            $errors[] = __('"%fieldName" is required. Enter and try again.', ['fieldName' => 'city']);
        }

        return $errors;
    }

As you can see in the code the city field is hardcoded in the rule validations but it's not actively checking the attribute whether it's required or not.

So the only way for a user to work around this is to create a plugin and set the billing city to some random string like a dash or a dot

In my opinion this should check the attribute's required column status

Examples

You just need to try and checkout without filling in the city after you change the required attribute value

+---------------+------+
|attribute_id   |29    |
+---------------+------+
|entity_type_id |2     |
+---------------+------+
|attribute_code |city  |
+---------------+------+
|attribute_model|null  |
+---------------+------+
|backend_model  |null  |
+---------------+------+
|backend_type   |static|
+---------------+------+
|backend_table  |null  |
+---------------+------+
|frontend_model |null  |
+---------------+------+
|frontend_input |text  |
+---------------+------+
|frontend_label |City  |
+---------------+------+
|frontend_class |null  |
+---------------+------+
|source_model   |null  |
+---------------+------+
|is_required    |0     |
+---------------+------+
|is_user_defined|0     |
+---------------+------+
|default_value  |null  |
+---------------+------+
|is_unique      |0     |
+---------------+------+
|note           |null  |
+---------------+------+

Proposed solution

Check the attribute before validating instead of hardcoding the requirement

Release note

No response

Triage and priority

• [ ] Severity: S0 - Affects critical data or functionality and leaves users without workaround.
• [X] Severity: S1 - Affects critical data or functionality and forces users to employ a workaround.
• [ ] Severity: S2 - Affects non-critical data or functionality and forces users to employ a workaround.
• [ ] Severity: S3 - Affects non-critical data or functionality and does not force users to employ a workaround.
• [ ] Severity: S4 - Affects aesthetics, professional look and feel, “quality” or “usability”.

[m2-assistant[bot]]

Hi @ioweb-gr. Thank you for your report. To speed up processing of this issue, make sure that the issue is reproducible on the vanilla Magento instance following Steps to reproduce. To deploy vanilla Magento instance on our environment, Add a comment to the issue:

• @magento give me 2.4-develop instance - upcoming 2.4.x release
• For more details, review the Magento Contributor Assistant documentation.
• Add a comment to assign the issue: @magento I am working on this
• To learn more about issue processing workflow, refer to the Code Contributions.

---

Join Magento Community Engineering Slack and ask your questions in #github channel. :warning: According to the Magento Contribution requirements, all issues must go through the Community Contributions Triage process. Community Contributions Triage is a public meeting. :clock10: You can find the schedule on the Magento Community Calendar page. :telephone_receiver: The triage of issues happens in the queue order. If you want to speed up the delivery of your contribution, join the Community Contributions Triage session to discuss the appropriate ticket.

[m2-assistant[bot]]

Hi @engcom-November. Thank you for working on this issue. In order to make sure that issue has enough information and ready for development, please read and check the following instruction: :point_down:

• [ ] 1. Verify that issue has all the required information. (Preconditions, Steps to reproduce, Expected result, Actual result).
• [ ] 2. Verify that issue has a meaningful description and provides enough information to reproduce the issue.
• [ ] 3. Add Area: XXXXX label to the ticket, indicating the functional areas it may be related to.
• [ ] 4. Verify that the issue is reproducible on 2.4-develop branch
  Details

  - Add the comment @magento give me 2.4-develop instance to deploy test instance on Magento infrastructure.
  - If the issue is reproducible on 2.4-develop branch, please, add the label Reproduced on 2.4.x.
  - If the issue is not reproducible, add your comment that issue is not reproducible and close the issue and stop verification process here!
• [ ] 5. Add label Issue: Confirmed once verification is complete.
• [ ] 6. Make sure that automatic system confirms that report has been added to the backlog.

[engcom-November]

Hello @ioweb-gr,

Thank you for the report and collaboration!

Verified this issue on 2.4-develop. We observed that during checkout, city was required even though it was made optional. Please take a look at the screenshot below:

Hence confirming the issue.

Thank you.

[github-jira-sync-bot]

:white_check_mark: Jira issue https://jira.corp.adobe.com/browse/AC-10790 is successfully created for this GitHub issue.

[m2-assistant[bot]]

:white_check_mark: Confirmed by @engcom-November. Thank you for verifying the issue.
Issue Available: @engcom-November, You will be automatically unassigned. Contributors/Maintainers can claim this issue to continue. To reclaim and continue work, reassign the ticket to yourself.

[SilinMykola]

@magento I am working on this