Allow construction of products with custom_attributes in $data

[Vinai]

This is a new PR because I accidentally deleted the previous remote branch for #24407

---

Description (*)

This patch does two things:

1. Currently it is not possible to pass an array with custom_attributes
   to the \Magento\Catalog\Model\Product constructor (it causes a fatal error).
   The reason is because the filterCustomAttribute and eavConfig arguments are
   assigned after the call to parent::__construct.
   However, the properties are used during the parent::__construct calls.
   The flow of execution is as follows:
   1. Product::__construct -> Catalog\Model\AbstractModel::__construct
   2. Catalog\Model\AbstractModel::__construct -> AbstractExtensibleModel::__construct
   3. AbstractExtensibleModel::__construct -> AbstractExtensibleModel::filterCustomAttributes
   4. AbstractExtensibleModel::filterCustomAttributes -> AbstractExtensibleModel::getCustomAttributesCodes
      ...which is overridden by Product::getCustomAttributesCodes.
      getCustomAttributesCodes expects the filterCustomAttribute and eavConfig properties to be set if custom_attributes are present in $data, but they are still null because the Product::__construct method has not yet completed.

The fix this PR applies is to assign the properties before the call to parent::__construct.
The bug and fix are covered by the integration test:
\Magento\Catalog\Model\ProductTest::testConstructionWithCustomAttributesMapInData

2. The method AbstractExtensibleModel::filterCustomAttribute expects the custom_attributes in $data to be a simple map from codes to values, e.g. ['category_ids => '1,2'].
   However, the method \Magento\Framework\Reflection\DataObjectProcessor::buildOutputDataArray generates a
   numerically indexed custom attributes array, where each custom attribute is a sub-array with a attribute_code and value record.
   This PR allows passing such an custom_attributes array into the Product model constructor.
   Currently it would be ignored, but with this patch the code checks if custom_attributes is numerically indexed, and if so, flattens the sub-arrays into the expected map format.
   To illustrate the difference of the custom_attributes array formats:

    // Map:
    [
        'custom_attributes' => [
            'category_ids' => '1,2',
            'tax_class_id'  => '3',
        ]
    ]

   // Numerically indexed array of sub-arrays:
    [
        'custom_attributes' => [
           [
                'attribute_code' => 'category_ids',
                'value'                => '1,2'
           ],
           [
               'attribute_code' => 'tax_class_id',
               'value'                 => '3'
           ],
    ]

This improvement is covered by the integration test
\Magento\Catalog\Model\ProductTest::testConstructionWithCustomAttributesArrayInData

Description (*)

Manual testing scenarios (*)

1. Instantiate Magento\Catalog\Model\Product and pass a $data array with a custom_attributes key to the constructor. The custom_attributes array can be a map or a numerically indexed array, the exception is thrown either way.
   Examples of how this can be done can be seen in the integration tests in this PR.

Contribution checklist (*)

• Pull request has a meaningful description of its purpose
• All commits are accompanied by meaningful commit messages
• All new or changed code is covered with unit/integration tests (if applicable)
• All automated tests passed successfully (all builds are green)

[m2-assistant]

Hi @Vinai. Thank you for your contribution
Here is some useful tips how you can test your changes using Magento test environment.
Add the comment under your pull request to deploy test or vanilla Magento instance:

• @magento give me test instance - deploy test instance based on PR changes
• @magento give me 2.3-develop instance - deploy vanilla Magento instance

For more details, please, review the Magento Contributor Guide documentation.

[Vinai]

Note to reviewers: This change is only in the PR because the static tests complained about the array_merge in a loop. I didn't write that loop, but I don't mind changing it to get the tests green.

[Vinai]

Resolved merge conflicts.

[Vinai]

I do not know why the Database Compare check fails, as the PR does not include any storage related changes. Can someone with more insight help, please?

[magento-engcom-team]

Hi @orlangur, thank you for the review.
ENGCOM-5836 has been created to process this Pull Request

[magento-engcom-team]

Hi @sidolov, thank you for the review.
ENGCOM-5836 has been created to process this Pull Request

[sidolov]

@engcom-Foxtrot , please, take a look at the failed test on the Magento Commerce and B2B edition:
Magento\FunctionalTestingFramework.functional.AdminCustomerCustomAddressMultilineAttributeTest
@Vinai looks like current implementation does not work with multiline attributes, probably the best way to check it - use multi-line address for order on the backend.

[engcom-Foxtrot]

@magento run all tests

[sdzhepa]

@magento run all tests

[engcom-Foxtrot]

@magento run all tests

[slavvka]

Internal BIC approval ticket https://jira.corp.magento.com/browse/MC-30325

[slavvka]

BIC ia approved

[engcom-Kilo]

✔️ QA Passed

[m2-assistant]

Hi @Vinai, thank you for your contribution!
Please, complete Contribution Survey, it will take less than a minute.
Your feedback will help us to improve contribution process.