MAGETWO-87292: 8035: Join extension attributes are not added to Order results (REST api) #1168

Author: Oleksii Korshenko

app/code/Magento/Sales/Model/OrderRepository.php

@@ -5,7 +5,9 @@
  */
 namespace Magento\Sales\Model;
 
+use Magento\Framework\Api\ExtensionAttribute\JoinProcessorInterface;
 use Magento\Framework\Api\SearchCriteria\CollectionProcessorInterface;
+use Magento\Framework\App\ObjectManager;
 use Magento\Framework\Exception\InputException;
 use Magento\Framework\Exception\NoSuchEntityException;
 use Magento\Sales\Api\Data\OrderExtensionFactory;
@@ -15,7 +17,6 @@
 use Magento\Sales\Api\Data\ShippingAssignmentInterface;
 use Magento\Sales\Model\Order\ShippingAssignmentBuilder;
 use Magento\Sales\Model\ResourceModel\Metadata;
-use Magento\Framework\App\ObjectManager;
 
 /**
  * Repository class
@@ -54,26 +55,35 @@ class OrderRepository implements \Magento\Sales\Api\OrderRepositoryInterface
      */
     protected $registry = [];
 
+    /**
+     * @var JoinProcessorInterface
+     */
+    private $extensionAttributesJoinProcessor;
+
     /**
      * Constructor
      *
      * @param Metadata $metadata
      * @param SearchResultFactory $searchResultFactory
      * @param CollectionProcessorInterface|null $collectionProcessor
      * @param \Magento\Sales\Api\Data\OrderExtensionFactory|null $orderExtensionFactory
+     * @param JoinProcessorInterface $extensionAttributesJoinProcessor
      */
     public function __construct(
         Metadata $metadata,
         SearchResultFactory $searchResultFactory,
         CollectionProcessorInterface $collectionProcessor = null,
-        \Magento\Sales\Api\Data\OrderExtensionFactory $orderExtensionFactory = null
+        \Magento\Sales\Api\Data\OrderExtensionFactory $orderExtensionFactory = null,
+        JoinProcessorInterface $extensionAttributesJoinProcessor = null
     ) {
         $this->metadata = $metadata;
         $this->searchResultFactory = $searchResultFactory;
         $this->collectionProcessor = $collectionProcessor ?: ObjectManager::getInstance()
             ->get(\Magento\Framework\Api\SearchCriteria\CollectionProcessorInterface::class);
         $this->orderExtensionFactory = $orderExtensionFactory ?: ObjectManager::getInstance()
             ->get(\Magento\Sales\Api\Data\OrderExtensionFactory::class);
+        $this->extensionAttributesJoinProcessor = $extensionAttributesJoinProcessor
+            ?: ObjectManager::getInstance()->get(JoinProcessorInterface::class);
     }
 
     /**
@@ -112,6 +122,7 @@ public function getList(\Magento\Framework\Api\SearchCriteriaInterface $searchCr
         /** @var \Magento\Sales\Api\Data\OrderSearchResultInterface $searchResult */
         $searchResult = $this->searchResultFactory->create();
         $this->collectionProcessor->process($searchCriteria, $searchResult);
+        $this->extensionAttributesJoinProcessor->process($searchResult);
         $searchResult->setSearchCriteria($searchCriteria);
         foreach ($searchResult->getItems() as $order) {
             $this->setShippingAssignments($order);

dev/tests/api-functional/_files/Magento/TestModuleJoinDirectives/etc/extension_attributes.xml

@@ -31,4 +31,16 @@
             </join>
         </attribute>
     </extension_attributes>
+    <extension_attributes for="Magento\Sales\Api\Data\OrderInterface">
+        <attribute code="orderApiTestAttribute" type="Magento\User\Api\Data\UserInterface">
+            <join reference_table="admin_user"
+                  join_on_field="store_id"
+                  reference_field="user_id"
+            >
+                <field>firstname</field>
+                <field>lastname</field>
+                <field>email</field>
+            </join>
+        </attribute>
+    </extension_attributes>
 </config>

dev/tests/api-functional/testsuite/Magento/Webapi/JoinDirectivesTest.php

@@ -6,11 +6,10 @@
 
 namespace Magento\Webapi;
 
+use Magento\Framework\Api\FilterBuilder;
 use Magento\Framework\Api\SearchCriteriaBuilder;
-use Magento\Framework\Api\SortOrderBuilder;
 use Magento\Framework\Api\SortOrder;
-use Magento\Framework\Api\SearchCriteria;
-use Magento\Framework\Api\FilterBuilder;
+use Magento\Framework\Api\SortOrderBuilder;
 
 class JoinDirectivesTest extends \Magento\TestFramework\TestCase\WebapiAbstract
 {
@@ -124,6 +123,49 @@ public function testAutoGeneratedGetList()
         $this->assertEquals($expectedExtensionAttributes['email'], $testAttribute['email']);
     }
 
+    /**
+     * Test get list of orders with extension attributes.
+     *
+     * @magentoApiDataFixture Magento/Sales/_files/order.php
+     */
+    public function testGetOrdertList()
+    {
+        $filter = $this->filterBuilder
+            ->setField('increment_id')
+            ->setValue('100000001')
+            ->setConditionType('eq')
+            ->create();
+        $this->searchBuilder->addFilters([$filter]);
+        $searchData = $this->searchBuilder->create()->__toArray();
+
+        $requestData = ['searchCriteria' => $searchData];
+
+        $restResourcePath = '/V1/orders/';
+        $soapService = 'salesOrderRepositoryV1';
+        $expectedExtensionAttributes = $this->getExpectedExtensionAttributes();
+
+        $serviceInfo = [
+            'rest' => [
+                'resourcePath' => $restResourcePath . '?' . http_build_query($requestData),
+                'httpMethod' => \Magento\Framework\Webapi\Rest\Request::HTTP_METHOD_GET,
+            ],
+            'soap' => [
+                'service' => $soapService,
+                'operation' => $soapService . 'GetList',
+            ],
+        ];
+        $searchResult = $this->_webApiCall($serviceInfo, $requestData);
+
+        $this->assertArrayHasKey('items', $searchResult);
+        $itemData = array_pop($searchResult['items']);
+        $this->assertArrayHasKey('extension_attributes', $itemData);
+        $this->assertArrayHasKey('order_api_test_attribute', $itemData['extension_attributes']);
+        $testAttribute = $itemData['extension_attributes']['order_api_test_attribute'];
+        $this->assertEquals($expectedExtensionAttributes['firstname'], $testAttribute['first_name']);
+        $this->assertEquals($expectedExtensionAttributes['lastname'], $testAttribute['last_name']);
+        $this->assertEquals($expectedExtensionAttributes['email'], $testAttribute['email']);
+    }
+
     /**
      * Retrieve the admin user's information.
      *