magento/magento2#8035: Join extension attributes are not added to Order results (REST api)

[swnsma]

Description (*)

FP fix of #8035 for 2.3.

Fixed Issues

1. Join extension attributes are not added to Order results (REST api) #8035: Join extension attributes are not added to Order results (REST api)

Manual testing scenarios (*)

1. Create new module.
2. Create new DB table, related to sales_order table (db_schema.xml):

<table name="custom_table" resource="default" engine="innodb">
    <column xsi:type="int" name="order_id" padding="10" unsigned="true" nullable="false" identity="true" comment="Order ID" />
    <column xsi:type="varchar" name="custom_field" nullable="false"/>
    <constraint xsi:type="foreign" referenceId="CUSTOM_TABLE_ORDER_ID_SALES_ORDER_ENTITY_ID" table="custom_table" column="order_id" referenceTable="sales_order"  referenceColumn="entity_id" onDelete="CASCADE"/>
    <constraint xsi:type="primary" referenceId="PRIMARY">
        <column name="order_id"/>
    </constraint>
</table>

3. Create new extension attribute for Order Entity (extension_attributes.xml):

<extension_attributes for="Magento\Sales\Api\Data\OrderInterface">
        <attribute code="custom_field" type="string">
            <join reference_table="custom_table" join_on_field="entity_id" reference_field="order_id">
                <field column="custom_field">custom_field</field>
            </join>
        </attribute>
    </extension_attributes>

4. Try to get list of orders from Order Repository, filtered by this attribute with using of search criteria.

        /** @var \Magento\Sales\Api\OrderRepositoryInterface $repository */
        $repository = ObjectManager::getInstance()->get('\Magento\Sales\Api\OrderRepositoryInterface');
        /** @var \Magento\Framework\Api\SearchCriteriaInterface $searchCriteria */
        $searchCriteria = ObjectManager::getInstance()->get('\Magento\Framework\Api\SearchCriteriaInterface');
        /** @var \Magento\Framework\Api\Search\FilterGroup $filterGroup */
        $filterGroup = ObjectManager::getInstance()->get('\Magento\Framework\Api\Search\FilterGroup');
        /** @var \Magento\Framework\Api\Filter $filter */
        $filter = ObjectManager::getInstance()->get('\Magento\Framework\Api\Filter');
        $filter->setField('custom_field');
        $filter->setValue('custom_value');
        $filter->setConditionType('eq');

        $filterGroup->setFilters([$filter]);
        $searchCriteria->setFilterGroups([$filterGroup]);

        $orderList = $repository->getList($searchCriteria);

E.R.:
List of orders, filtered by criteria.
A.R.:
SQLSTATE[42S22]: Column not found exception

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 on Travis CI are green)

[magento-engcom-team]

Hi @swnsma. 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-engcom-team give me test instance - deploy test instance based on PR changes
• @magento-engcom-team give me 2.3-develop instance - deploy vanilla Magento instance

For more details, please, review the Magento Contributor Assistant documentation

[magento-engcom-team]

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

[ishakhsuvarov]

Also, relates to: magento/inventory#2082

[m2-assistant]

Hi @swnsma, 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.