Msi 2182 source entity expansion with pickup location attributes

app/code/Magento/InventoryInStorePickup/Model/PickupLocation.php

@@ -91,11 +91,6 @@ class PickupLocation implements PickupLocationInterface
      */
     private $phone;
 
-    /**
-     * @var string[]|null
-     */
-    private $openHours;
-
     /**
      * @var string|null
      */
@@ -117,7 +112,6 @@ class PickupLocation implements PickupLocationInterface
      * @param string|null $street
      * @param string|null $postcode
      * @param string|null $phone
-     * @param string[]|null $openHours
      * @param PickupLocationExtensionInterface|null $extensionAttributes
      */
     public function __construct(
@@ -136,7 +130,6 @@ public function __construct(
         ?string $street = null,
         ?string $postcode = null,
         ?string $phone = null,
-        ?array $openHours = null,
         ?PickupLocationExtensionInterface $extensionAttributes = null
     ) {
         $this->sourceCode = $sourceCode;
@@ -154,7 +147,6 @@ public function __construct(
         $this->street = $street;
         $this->postcode = $postcode;
         $this->phone = $phone;
-        $this->openHours = $openHours;
         $this->extensionAttributes = $extensionAttributes;
     }
 
@@ -278,14 +270,6 @@ public function getPhone(): ?string
         return $this->phone;
     }
 
-    /**
-     * @inheritdoc
-     */
-    public function getOpenHours(): ?array
-    {
-        return $this->openHours;
-    }
-
     /**
      * @inheritdoc
      */

app/code/Magento/InventoryInStorePickup/Model/Source/SetExtensionAttributes.php

@@ -0,0 +1,55 @@
+<?php
+/**
+ * Copyright © Magento, Inc. All rights reserved.
+ * See COPYING.txt for license details.
+ */
+
+declare(strict_types=1);
+
+namespace Magento\InventoryInStorePickup\Model\Source;
+
+use Magento\Framework\Api\ExtensionAttributesFactory;
+use Magento\Framework\DataObject;
+use Magento\InventoryApi\Api\Data\SourceInterface;
+use Magento\InventoryInStorePickupApi\Api\Data\PickupLocationInterface;
+
+/**
+ * Set store-pickup related source extension attributes
+ */
+class SetExtensionAttributes
+{
+    /**
+     * @var ExtensionAttributesFactory
+     */
+    private $extensionAttributesFactory;
+
+    /**
+     * @param ExtensionAttributesFactory $extensionAttributesFactory
+     */
+    public function __construct(ExtensionAttributesFactory $extensionAttributesFactory)
+    {
+        $this->extensionAttributesFactory = $extensionAttributesFactory;
+    }
+    /**
+     * @param SourceInterface|DataObject $source
+     */
+    public function execute(SourceInterface $source): void
+    {
+        $pickupAvailable = $source->getData(PickupLocationInterface::IS_PICKUP_LOCATION_ACTIVE);
+        $frontendName = $source->getData(PickupLocationInterface::FRONTEND_NAME);
+        $frontendDescription = $source->getData(PickupLocationInterface::FRONTEND_DESCRIPTION);
+
+        $extensionAttributes = $source->getExtensionAttributes();
+
+        if ($extensionAttributes === null) {
+            $extensionAttributes = $this->extensionAttributesFactory->create(SourceInterface::class);
+            /** @noinspection PhpParamsInspection */
+            $source->setExtensionAttributes($extensionAttributes);
+        }
+
+        $extensionAttributes
+            ->setIsPickupLocationActive((bool)$pickupAvailable)
+            ->setFrontendName($frontendName)
+            ->setFrontendDescription($frontendDescription);
+    }
+}

app/code/Magento/InventoryInStorePickup/Plugin/InventoryApi/SourceRepository/LoadInStorePickupOnGetListPlugin.php

@@ -7,25 +7,24 @@
 
 namespace Magento\InventoryInStorePickup\Plugin\InventoryApi\SourceRepository;
 
-use Magento\Framework\Api\ExtensionAttributesFactory;
-use Magento\InventoryApi\Api\Data\SourceInterface;
 use Magento\InventoryApi\Api\Data\SourceSearchResultsInterface;
 use Magento\InventoryApi\Api\SourceRepositoryInterface;
-use Magento\InventoryInStorePickupApi\Api\Data\PickupLocationInterface;
+use Magento\InventoryInStorePickup\Model\Source\SetExtensionAttributes;
 
 class LoadInStorePickupOnGetListPlugin
 {
     /**
-     * @var ExtensionAttributesFactory
+     * @var SetExtensionAttributes
      */
-    private $extensionAttributesFactory;
+    private $setExtensionAttributes;
 
     /**
-     * @param ExtensionAttributesFactory $extensionAttributesFactory
+     * @param SetExtensionAttributes $setExtensionAttributes
      */
-    public function __construct(ExtensionAttributesFactory $extensionAttributesFactory)
-    {
-        $this->extensionAttributesFactory = $extensionAttributesFactory;
+    public function __construct(
+        SetExtensionAttributes $setExtensionAttributes
+    ) {
+        $this->setExtensionAttributes = $setExtensionAttributes;
     }
 
     /**
@@ -40,18 +39,12 @@ public function __construct(ExtensionAttributesFactory $extensionAttributesFacto
     public function afterGetList(
         SourceRepositoryInterface $subject,
         SourceSearchResultsInterface $sourceSearchResults
-    ):SourceSearchResultsInterface {
-        foreach ($sourceSearchResults->getItems() as $source) {
-            $extensionAttributes = $source->getExtensionAttributes();
-
-            if ($extensionAttributes === null) {
-                $extensionAttributes = $this->extensionAttributesFactory->create(SourceInterface::class);
-                $source->setExtensionAttributes($extensionAttributes);
-            }
-
-            $pickupAvailable = $source->getData(PickupLocationInterface::IS_PICKUP_LOCATION_ACTIVE);
-            $extensionAttributes->setIsPickupLocationActive((bool)$pickupAvailable);
-        }
+    ): SourceSearchResultsInterface {
+        $items = $sourceSearchResults->getItems();
+        array_walk(
+            $items,
+            [$this->setExtensionAttributes, 'execute']
+        );
 
         return $sourceSearchResults;
     }

app/code/Magento/InventoryInStorePickup/Plugin/InventoryApi/SourceRepository/LoadInStorePickupOnGetPlugin.php

@@ -7,49 +7,41 @@
 
 namespace Magento\InventoryInStorePickup\Plugin\InventoryApi\SourceRepository;
 
-use Magento\Framework\Api\ExtensionAttributesFactory;
+use Magento\Framework\DataObject;
 use Magento\InventoryApi\Api\Data\SourceInterface;
 use Magento\InventoryApi\Api\SourceRepositoryInterface;
-use Magento\InventoryInStorePickupApi\Api\Data\PickupLocationInterface;
+use Magento\InventoryInStorePickup\Model\Source\SetExtensionAttributes;
 
 class LoadInStorePickupOnGetPlugin
 {
     /**
-     * @var \Magento\Framework\Api\ExtensionAttributesFactory
+     * @var SetExtensionAttributes
      */
-    private $extensionAttributesFactory;
+    private $setExtensionAttributes;
 
     /**
-     * @param \Magento\Framework\Api\ExtensionAttributesFactory $extensionAttributesFactory
+     * @param SetExtensionAttributes $setExtensionAttributes
      */
-    public function __construct(ExtensionAttributesFactory $extensionAttributesFactory)
-    {
-        $this->extensionAttributesFactory = $extensionAttributesFactory;
+    public function __construct(
+        SetExtensionAttributes $setExtensionAttributes
+    ) {
+        $this->setExtensionAttributes = $setExtensionAttributes;
     }
 
     /**
      * Enrich the given Source Objects with the In-Store pickup attribute
      *
      * @param SourceRepositoryInterface $subject
-     * @param SourceInterface $source
+     * @param SourceInterface|DataObject $source
      *
      * @return SourceInterface
      * @SuppressWarnings(PHPMD.UnusedFormalParameter)
      */
     public function afterGet(
         SourceRepositoryInterface $subject,
         SourceInterface $source
-    ):SourceInterface {
-        $pickupAvailable = $source->getData(PickupLocationInterface::IS_PICKUP_LOCATION_ACTIVE);
-
-        $extensionAttributes = $source->getExtensionAttributes();
-
-        if ($extensionAttributes === null) {
-            $extensionAttributes = $this->extensionAttributesFactory->create(SourceInterface::class);
-            $source->setExtensionAttributes($extensionAttributes);
-        }
-
-        $extensionAttributes->setIsPickupLocationActive((bool)$pickupAvailable);
+    ): SourceInterface {
+        $this->setExtensionAttributes->execute($source);
 
         return $source;
     }

app/code/Magento/InventoryInStorePickup/Plugin/InventoryApi/SourceRepository/SaveInStorePickupPlugin.php

@@ -7,28 +7,32 @@
 
 namespace Magento\InventoryInStorePickup\Plugin\InventoryApi\SourceRepository;
 
+use Magento\Framework\DataObject;
 use Magento\InventoryApi\Api\Data\SourceInterface;
 use Magento\InventoryApi\Api\SourceRepositoryInterface;
+use Magento\InventoryInStorePickupApi\Api\Data\PickupLocationInterface as Location;
 
 class SaveInStorePickupPlugin
 {
     /**
      * Persist the In-Store pickup attribute on Source save
      *
      * @param SourceRepositoryInterface $subject
-     * @param SourceInterface $source
+     * @param SourceInterface|DataObject $source
      *
      * @return array
      * @SuppressWarnings(PHPMD.UnusedFormalParameter)
      */
     public function beforeSave(
         SourceRepositoryInterface $subject,
         SourceInterface $source
-    ):array {
+    ): array {
         $extensionAttributes = $source->getExtensionAttributes();
 
-        if ($extensionAttributes !== null && $extensionAttributes->getIsPickupLocationActive() !== null) {
-            $source->setIsPickupLocationActive($extensionAttributes->getIsPickupLocationActive());
+        if ($extensionAttributes !== null) {
+            $source->setData(Location::IS_PICKUP_LOCATION_ACTIVE, $extensionAttributes->getIsPickupLocationActive());
+            $source->setData(Location::FRONTEND_NAME, $extensionAttributes->getFrontendName());
+            $source->setData(Location::FRONTEND_DESCRIPTION, $extensionAttributes->getFrontendDescription());
         }
 
         return [$source];

app/code/Magento/InventoryInStorePickup/Plugin/InventoryApi/SourceValidatorChain/SetFrontendName.php

@@ -0,0 +1,40 @@
+<?php
+/**
+ * Copyright © Magento, Inc. All rights reserved.
+ * See COPYING.txt for license details.
+ */
+
+declare(strict_types=1);
+
+namespace Magento\InventoryInStorePickup\Plugin\InventoryApi\SourceValidatorChain;
+
+use Magento\Framework\DataObject;
+use Magento\InventoryApi\Api\Data\SourceInterface;
+use Magento\InventoryApi\Model\SourceValidatorChain;
+
+/**
+ * Set frontend name the same as regular name if it is empty
+ */
+class SetFrontendName
+{
+    /**
+     * @param SourceValidatorChain $chain
+     * @param SourceInterface $source
+     * @SuppressWarnings(PHPMD.UnusedFormalParameter)
+     */
+    public function beforeValidate(SourceValidatorChain $chain, SourceInterface $source)
+    {
+        if ($source->getExtensionAttributes() === null) {
+            return;
+        }
+
+        $frontendName = trim($source->getExtensionAttributes()->getFrontendName());
+
+        if ($frontendName === '') {
+            $source->getExtensionAttributes()->setFrontendName($source->getName());
+            if ($source instanceof DataObject) {
+                $source->setData('frontend_name', $source->getExtensionAttributes()->getFrontendName());
+            }
+        }
+    }
+}

app/code/Magento/InventoryInStorePickup/Test/Integration/Extension/InventorySourceExtensionTest.php

@@ -34,21 +34,22 @@ protected function setUp()
     public function testGetListOfSourcesWithPickupLocationExtensionAfterSave()
     {
         $pickupLocationConfig = [
-            'default' => false,
-            'eu-1' => true,
-            'eu-2' => true,
-            'eu-3' => false,
-            'eu-disabled' => false,
-            'us-1' => true,
+            'default' => ['active' => false, 'name' => 'default', 'desc' => 'default'],
+            'eu-1' => ['active' => true, 'name' => '', 'desc' => ''],
+            'eu-2' => ['active' => true, 'name' => 'zzz', 'desc' => ''],
+            'eu-3' => ['active' => false, 'name' => '', 'desc' => 'zzz1'],
+            'eu-disabled' => ['active' => false, 'name' => '', 'desc' => ''],
+            'us-1' => ['active' => true, 'name' => '666', 'desc' => ''],
         ];
 
         $searchResult = $this->sourceRepository->getList();
 
         /** @var SourceInterface $item */
         foreach ($searchResult->getItems() as $item) {
-            $item->getExtensionAttributes()->setIsPickupLocationActive(
-                $pickupLocationConfig[$item->getSourceCode()]
-            );
+            $item->getExtensionAttributes()
+                 ->setIsPickupLocationActive($pickupLocationConfig[$item->getSourceCode()]['active'])
+                 ->setFrontendDescription($pickupLocationConfig[$item->getSourceCode()]['desc'])
+                 ->setFrontendName($pickupLocationConfig[$item->getSourceCode()]['name']);
             $this->sourceRepository->save($item);
         }
 
@@ -57,7 +58,10 @@ public function testGetListOfSourcesWithPickupLocationExtensionAfterSave()
         $pickupLocationsStatus = [];
 
         foreach ($searchResult->getItems() as $item) {
-            $pickupLocationsStatus[$item->getSourceCode()] = $item->getExtensionAttributes()->getIsPickupLocationActive();
+            $extension = $item->getExtensionAttributes();
+            $pickupLocationsStatus[$item->getSourceCode()]['active'] = $extension->getIsPickupLocationActive();
+            $pickupLocationsStatus[$item->getSourceCode()]['name'] = $extension->getFrontendName();
+            $pickupLocationsStatus[$item->getSourceCode()]['desc'] = $extension->getFrontendDescription();
         }
 
         $this->assertEquals($pickupLocationConfig, $pickupLocationsStatus);
@@ -71,10 +75,15 @@ public function testGetSourceWithPickupLocationExtensionAfterSave()
         $sourceCode = 'source-code-1';
 
         $source = $this->sourceRepository->get($sourceCode);
-        $source->getExtensionAttributes()->setIsPickupLocationActive(true);
+        $source->getExtensionAttributes()
+               ->setIsPickupLocationActive(true)
+               ->setFrontendName('zzz')
+               ->setFrontendDescription('666');
         $this->sourceRepository->save($source);
 
         $source = $this->sourceRepository->get($sourceCode);
         $this->assertEquals(true, $source->getExtensionAttributes()->getIsPickupLocationActive());
+        $this->assertEquals('zzz', $source->getExtensionAttributes()->getFrontendName());
+        $this->assertEquals('666', $source->getExtensionAttributes()->getFrontendDescription());
     }
 }