MAGETWO-94347: Implement handling of large number of addresses on storefront Address book

le0n4eg · le0n4eg · commit 37bda719e55f · 2019-01-04T10:54:30.000-06:00
diff --git a/app/code/Magento/Customer/Block/Address/Book.php b/app/code/Magento/Customer/Block/Address/Book.php
@@ -93,7 +93,8 @@ protected function _prepareLayout()
      * Generate and return "New Address" URL
      *
      * @return string
-     * @deprecated not used in this block (new block for additional addresses: \Magento\Customer\Block\Address\Grid
+     * @deprecated not used in this block
+     * @see \Magento\Customer\Block\Address\Grid::getAddAddressUrl
      */
     public function getAddAddressUrl()
     {
@@ -117,7 +118,8 @@ public function getBackUrl()
      * Generate and return "Delete" URL
      *
      * @return string
-     * @deprecated not used in this block (new block for additional addresses: \Magento\Customer\Block\Address\Grid
+     * @deprecated not used in this block
+     * @see \Magento\Customer\Block\Address\Grid::getDeleteUrl
      */
     public function getDeleteUrl()
     {
@@ -131,7 +133,8 @@ public function getDeleteUrl()
      *
      * @param int $addressId
      * @return string
-     * @deprecated not used in this block (new block for additional addresses: \Magento\Customer\Block\Address\Grid
+     * @deprecated not used in this block
+     * @see \Magento\Customer\Block\Address\Grid::getAddressEditUrl
      */
     public function getAddressEditUrl($addressId)
     {
@@ -156,11 +159,16 @@ public function hasPrimaryAddress()
      *
      * @return \Magento\Customer\Api\Data\AddressInterface[]|bool
      * @throws \Magento\Framework\Exception\LocalizedException
-     * @deprecated not used in this block (new block for additional addresses: \Magento\Customer\Block\Address\Grid
+     * @deprecated not used in this block
+     * @see \Magento\Customer\Block\Address\Grid::getAdditionalAddresses
      */
     public function getAdditionalAddresses()
     {
-        return $this->addressesGrid->getAdditionalAddresses();
+        try {
+            $addresses = $this->addressesGrid->getAdditionalAddresses();
+        } catch (\Magento\Framework\Exception\NoSuchEntityException $e) {
+        }
+        return empty($addresses) ? false : $addresses;
     }
 
     /**
@@ -182,14 +190,16 @@ public function getAddressHtml(\Magento\Customer\Api\Data\AddressInterface $addr
     /**
      * Get current customer
      *
-     * Check if customer is stored in current object and return it
-     * or get customer by current customer ID through repository
-     *
      * @return \Magento\Customer\Api\Data\CustomerInterface|null
      */
     public function getCustomer()
     {
-        return $this->addressesGrid->getCustomer();
+        $customer = null;
+        try {
+            $customer = $this->currentCustomer->getCustomer();
+        } catch (\Magento\Framework\Exception\NoSuchEntityException $e) {
+        }
+        return $customer;
     }
 
     /**
diff --git a/app/code/Magento/Customer/Block/Address/Grid.php b/app/code/Magento/Customer/Block/Address/Grid.php
@@ -1,4 +1,5 @@
 <?php
+declare(strict_types=1);
 /**
  * Copyright © Magento, Inc. All rights reserved.
  * See COPYING.txt for license details.
@@ -58,22 +59,21 @@ public function __construct(
     /**
      * Prepare the Address Book section layout
      *
-     * @return $this
+     * @return void
      * @throws \Magento\Framework\Exception\LocalizedException
      */
-    protected function _prepareLayout()
+    protected function _prepareLayout(): void
     {
         parent::_prepareLayout();
         $this->preparePager();
-        return $this;
     }
 
     /**
      * Generate and return "New Address" URL
      *
      * @return string
      */
-    public function getAddAddressUrl()
+    public function getAddAddressUrl(): string
     {
         return $this->getUrl('customer/address/new', ['_secure' => true]);
     }
@@ -83,7 +83,7 @@ public function getAddAddressUrl()
      *
      * @return string
      */
-    public function getDeleteUrl()
+    public function getDeleteUrl(): string
     {
         return $this->getUrl('customer/address/delete');
     }
@@ -96,7 +96,7 @@ public function getDeleteUrl()
      * @param int $addressId
      * @return string
      */
-    public function getAddressEditUrl($addressId)
+    public function getAddressEditUrl($addressId): string
     {
         return $this->getUrl('customer/address/edit', ['_secure' => true, 'id' => $addressId]);
     }
@@ -106,42 +106,35 @@ public function getAddressEditUrl($addressId)
      *
      * Will return array of address interfaces if customer have additional addresses and false in other case.
      *
-     * @return \Magento\Customer\Api\Data\AddressInterface[]|bool
+     * @return \Magento\Customer\Api\Data\AddressInterface[]
      * @throws \Magento\Framework\Exception\LocalizedException
+     * @throws NoSuchEntityException
      */
-    public function getAdditionalAddresses()
+    public function getAdditionalAddresses(): array
     {
-        try {
-            $addresses = $this->getAddressCollection();
-        } catch (\Magento\Framework\Exception\NoSuchEntityException $e) {
-            return false;
-        }
+        $additional = [];
+        $addresses = $this->getAddressCollection();
         $primaryAddressIds = [$this->getDefaultBilling(), $this->getDefaultShipping()];
         foreach ($addresses as $address) {
-            if (!in_array($address->getId(), $primaryAddressIds)) {
+            if (!in_array((int)$address->getId(), $primaryAddressIds, true)) {
                 $additional[] = $address->getDataModel();
             }
         }
-        return empty($additional) ? false : $additional;
+        return $additional;
     }
 
     /**
      * Get current customer
      *
-     * Check if customer is stored in current object and return it
-     * or get customer by current customer ID through repository
+     * Return stored customer or get it from session
      *
-     * @return \Magento\Customer\Api\Data\CustomerInterface|null
+     * @return \Magento\Customer\Api\Data\CustomerInterface
      */
-    public function getCustomer()
+    public function getCustomer(): \Magento\Customer\Api\Data\CustomerInterface
     {
         $customer = $this->getData('customer');
         if ($customer === null) {
-            try {
-                $customer = $this->currentCustomer->getCustomer();
-            } catch (\Magento\Framework\Exception\NoSuchEntityException $e) {
-                return null;
-            }
+            $customer = $this->currentCustomer->getCustomer();
             $this->setData('customer', $customer);
         }
         return $customer;
@@ -153,7 +146,7 @@ public function getCustomer()
      * @param string|array $street
      * @return string
      */
-    public function getStreetAddress($street)
+    public function getStreetAddress($street): string
     {
         if (is_array($street)) {
             $street = implode(', ', $street);
@@ -169,7 +162,7 @@ public function getStreetAddress($street)
      * @param string $countryCode
      * @return string
      */
-    public function getCountryByCode($countryCode)
+    public function getCountryByCode($countryCode): string
     {
         /** @var \Magento\Directory\Model\Country $country */
         $country = $this->countryFactory->create();
@@ -181,38 +174,38 @@ public function getCountryByCode($countryCode)
      * Get default billing address
      * Return address string if address found and null of not
      *
-     * @return string
+     * @return int
      * @throws \Magento\Framework\Exception\LocalizedException
      */
-    private function getDefaultBilling()
+    private function getDefaultBilling(): int
     {
         $customer = $this->getCustomer();
 
-        return $customer->getDefaultBilling();
+        return (int)$customer->getDefaultBilling();
     }
 
 
     /**
      * Get default shipping address
      * Return address string if address found and null of not
      *
-     * @return string
+     * @return int
      * @throws \Magento\Framework\Exception\LocalizedException
      */
-    private function getDefaultShipping()
+    private function getDefaultShipping(): int
     {
         $customer = $this->getCustomer();
 
-        return $customer->getDefaultShipping();
+        return (int)$customer->getDefaultShipping();
     }
 
     /**
      * Get pager layout
      *
-     * @return void
+     * @return f
      * @throws \Magento\Framework\Exception\LocalizedException
      */
-    private function preparePager()
+    private function preparePager(): void
     {
         $addressCollection = $this->getAddressCollection();
         if (null !== $addressCollection) {
@@ -232,7 +225,7 @@ private function preparePager()
      * @return \Magento\Customer\Model\ResourceModel\Address\Collection
      * @throws NoSuchEntityException
      */
-    private function getAddressCollection()
+    private function getAddressCollection(): \Magento\Customer\Model\ResourceModel\Address\Collection
     {
         if (null === $this->addressCollection && $this->getCustomer()) {
             /** @var \Magento\Customer\Model\ResourceModel\Address\Collection $collection */
diff --git a/dev/tests/integration/testsuite/Magento/Customer/Block/Address/GridTest.php b/dev/tests/integration/testsuite/Magento/Customer/Block/Address/GridTest.php
@@ -94,7 +94,7 @@ public function testGetAdditionalAddressesNegative($customerId, $expected)
 
     public function getAdditionalAddressesDataProvider()
     {
-        return ['5' => [5, false]];
+        return ['5' => [5, []]];
     }
 
     /**
@@ -123,43 +123,6 @@ public function testGetCustomer()
         $this->assertEquals($customer, $object);
     }
 
-    /**
-     * @magentoDataFixture Magento/Customer/_files/customer.php
-     * @magentoDataFixture Magento/Customer/_files/customer_two_addresses.php
-     * @magentoDataFixture Magento/Customer/_files/customer_no_address.php
-     * @dataProvider getDefaultBillingDataProvider
-     * @magentoAppIsolation enabled
-     */
-    public function testGetDefaultBilling($customerId, $expected)
-    {
-        $gridBlock = $this->createBlockForCustomer($customerId);
-        $this->assertEquals($expected, $gridBlock->getDefaultBilling());
-    }
-
-    public function getDefaultBillingDataProvider()
-    {
-        return ['1' => [1, 1], '5' => [5, null]];
-    }
-
-    /**
-     * @magentoDataFixture Magento/Customer/_files/customer.php
-     * @magentoDataFixture Magento/Customer/_files/customer_two_addresses.php
-     * @magentoDataFixture Magento/Customer/_files/customer_no_address.php
-     * @dataProvider getDefaultShippingDataProvider
-     * @magentoAppIsolation enabled
-     */
-    public function testGetDefaultShipping($customerId, $expected)
-    {
-        $gridBlock = $this->createBlockForCustomer($customerId);
-        $this->currentCustomer->setCustomerId($customerId);
-        $this->assertEquals($expected, $gridBlock->getDefaultShipping());
-    }
-
-    public function getDefaultShippingDataProvider()
-    {
-        return ['1' => [1, 1], '5' => [5, null]];
-    }
-
     /**
      * Create address book block for customer
      *

Original file line number	Diff line number	Diff line change
`@@ -93,7 +93,8 @@ protected function _prepareLayout()`
`93`	`93`	`* Generate and return "New Address" URL`
`94`	`94`	`*`
`95`	`95`	`* @return string`
`96`		`- * @deprecated not used in this block (new block for additional addresses: \Magento\Customer\Block\Address\Grid`
	`96`	`+ * @deprecated not used in this block`
	`97`	`+ * @see \Magento\Customer\Block\Address\Grid::getAddAddressUrl`
`97`	`98`	`*/`
`98`	`99`	`public function getAddAddressUrl()`
`99`	`100`	`{`
`@@ -117,7 +118,8 @@ public function getBackUrl()`
`117`	`118`	`* Generate and return "Delete" URL`
`118`	`119`	`*`
`119`	`120`	`* @return string`
`120`		`- * @deprecated not used in this block (new block for additional addresses: \Magento\Customer\Block\Address\Grid`
	`121`	`+ * @deprecated not used in this block`
	`122`	`+ * @see \Magento\Customer\Block\Address\Grid::getDeleteUrl`
`121`	`123`	`*/`
`122`	`124`	`public function getDeleteUrl()`
`123`	`125`	`{`
`@@ -131,7 +133,8 @@ public function getDeleteUrl()`
`131`	`133`	`*`
`132`	`134`	`* @param int $addressId`
`133`	`135`	`* @return string`
`134`		`- * @deprecated not used in this block (new block for additional addresses: \Magento\Customer\Block\Address\Grid`
	`136`	`+ * @deprecated not used in this block`
	`137`	`+ * @see \Magento\Customer\Block\Address\Grid::getAddressEditUrl`
`135`	`138`	`*/`
`136`	`139`	`public function getAddressEditUrl($addressId)`
`137`	`140`	`{`
`@@ -156,11 +159,16 @@ public function hasPrimaryAddress()`
`156`	`159`	`*`
`157`	`160`	`* @return \Magento\Customer\Api\Data\AddressInterface[]\|bool`
`158`	`161`	`* @throws \Magento\Framework\Exception\LocalizedException`
`159`		`- * @deprecated not used in this block (new block for additional addresses: \Magento\Customer\Block\Address\Grid`
	`162`	`+ * @deprecated not used in this block`
	`163`	`+ * @see \Magento\Customer\Block\Address\Grid::getAdditionalAddresses`
`160`	`164`	`*/`
`161`	`165`	`public function getAdditionalAddresses()`
`162`	`166`	`{`
`163`		`- return $this->addressesGrid->getAdditionalAddresses();`
	`167`	`+ try {`
	`168`	`+ $addresses = $this->addressesGrid->getAdditionalAddresses();`
	`169`	`+ } catch (\Magento\Framework\Exception\NoSuchEntityException $e) {`
	`170`	`+ }`
	`171`	`+ return empty($addresses) ? false : $addresses;`
`164`	`172`	`}`
`165`	`173`
`166`	`174`	`/**`
`@@ -182,14 +190,16 @@ public function getAddressHtml(\Magento\Customer\Api\Data\AddressInterface $addr`
`182`	`190`	`/**`
`183`	`191`	`* Get current customer`
`184`	`192`	`*`
`185`		`- * Check if customer is stored in current object and return it`
`186`		`- * or get customer by current customer ID through repository`
`187`		`- *`
`188`	`193`	`* @return \Magento\Customer\Api\Data\CustomerInterface\|null`
`189`	`194`	`*/`
`190`	`195`	`public function getCustomer()`
`191`	`196`	`{`
`192`		`- return $this->addressesGrid->getCustomer();`
	`197`	`+ $customer = null;`
	`198`	`+ try {`
	`199`	`+ $customer = $this->currentCustomer->getCustomer();`
	`200`	`+ } catch (\Magento\Framework\Exception\NoSuchEntityException $e) {`
	`201`	`+ }`
	`202`	`+ return $customer;`
`193`	`203`	`}`
`194`	`204`
`195`	`205`	`/**`
Original file line number	Diff line number	Diff line change
`@@ -1,4 +1,5 @@`
`1`	`1`	`<?php`
	`2`	`+declare(strict_types=1);`
`2`	`3`	`/**`
`3`	`4`	`* Copyright © Magento, Inc. All rights reserved.`
`4`	`5`	`* See COPYING.txt for license details.`
`@@ -58,22 +59,21 @@ public function __construct(`
`58`	`59`	`/**`
`59`	`60`	`* Prepare the Address Book section layout`
`60`	`61`	`*`
`61`		`- * @return $this`
	`62`	`+ * @return void`
`62`	`63`	`* @throws \Magento\Framework\Exception\LocalizedException`
`63`	`64`	`*/`
`64`		`- protected function _prepareLayout()`
	`65`	`+ protected function _prepareLayout(): void`
`65`	`66`	`{`
`66`	`67`	`parent::_prepareLayout();`
`67`	`68`	`$this->preparePager();`
`68`		`- return $this;`
`69`	`69`	`}`
`70`	`70`
`71`	`71`	`/**`
`72`	`72`	`* Generate and return "New Address" URL`
`73`	`73`	`*`
`74`	`74`	`* @return string`
`75`	`75`	`*/`
`76`		`- public function getAddAddressUrl()`
	`76`	`+ public function getAddAddressUrl(): string`
`77`	`77`	`{`
`78`	`78`	`return $this->getUrl('customer/address/new', ['_secure' => true]);`
`79`	`79`	`}`
`@@ -83,7 +83,7 @@ public function getAddAddressUrl()`
`83`	`83`	`*`
`84`	`84`	`* @return string`
`85`	`85`	`*/`
`86`		`- public function getDeleteUrl()`
	`86`	`+ public function getDeleteUrl(): string`
`87`	`87`	`{`
`88`	`88`	`return $this->getUrl('customer/address/delete');`
`89`	`89`	`}`
`@@ -96,7 +96,7 @@ public function getDeleteUrl()`
`96`	`96`	`* @param int $addressId`
`97`	`97`	`* @return string`
`98`	`98`	`*/`
`99`		`- public function getAddressEditUrl($addressId)`
	`99`	`+ public function getAddressEditUrl($addressId): string`
`100`	`100`	`{`
`101`	`101`	`return $this->getUrl('customer/address/edit', ['_secure' => true, 'id' => $addressId]);`
`102`	`102`	`}`
`@@ -106,42 +106,35 @@ public function getAddressEditUrl($addressId)`
`106`	`106`	`*`
`107`	`107`	`* Will return array of address interfaces if customer have additional addresses and false in other case.`
`108`	`108`	`*`
`109`		`- * @return \Magento\Customer\Api\Data\AddressInterface[]\|bool`
	`109`	`+ * @return \Magento\Customer\Api\Data\AddressInterface[]`
`110`	`110`	`* @throws \Magento\Framework\Exception\LocalizedException`
	`111`	`+ * @throws NoSuchEntityException`
`111`	`112`	`*/`
`112`		`- public function getAdditionalAddresses()`
	`113`	`+ public function getAdditionalAddresses(): array`
`113`	`114`	`{`
`114`		`- try {`
`115`		`- $addresses = $this->getAddressCollection();`
`116`		`- } catch (\Magento\Framework\Exception\NoSuchEntityException $e) {`
`117`		`- return false;`
`118`		`- }`
	`115`	`+ $additional = [];`
	`116`	`+ $addresses = $this->getAddressCollection();`
`119`	`117`	`$primaryAddressIds = [$this->getDefaultBilling(), $this->getDefaultShipping()];`
`120`	`118`	`foreach ($addresses as $address) {`
`121`		`- if (!in_array($address->getId(), $primaryAddressIds)) {`
	`119`	`+ if (!in_array((int)$address->getId(), $primaryAddressIds, true)) {`
`122`	`120`	`$additional[] = $address->getDataModel();`
`123`	`121`	`}`
`124`	`122`	`}`
`125`		`- return empty($additional) ? false : $additional;`
	`123`	`+ return $additional;`
`126`	`124`	`}`
`127`	`125`
`128`	`126`	`/**`
`129`	`127`	`* Get current customer`
`130`	`128`	`*`
`131`		`- * Check if customer is stored in current object and return it`
`132`		`- * or get customer by current customer ID through repository`
	`129`	`+ * Return stored customer or get it from session`
`133`	`130`	`*`
`134`		`- * @return \Magento\Customer\Api\Data\CustomerInterface\|null`
	`131`	`+ * @return \Magento\Customer\Api\Data\CustomerInterface`
`135`	`132`	`*/`
`136`		`- public function getCustomer()`
	`133`	`+ public function getCustomer(): \Magento\Customer\Api\Data\CustomerInterface`
`137`	`134`	`{`
`138`	`135`	`$customer = $this->getData('customer');`
`139`	`136`	`if ($customer === null) {`
`140`		`- try {`
`141`		`- $customer = $this->currentCustomer->getCustomer();`
`142`		`- } catch (\Magento\Framework\Exception\NoSuchEntityException $e) {`
`143`		`- return null;`
`144`		`- }`
	`137`	`+ $customer = $this->currentCustomer->getCustomer();`
`145`	`138`	`$this->setData('customer', $customer);`
`146`	`139`	`}`
`147`	`140`	`return $customer;`
`@@ -153,7 +146,7 @@ public function getCustomer()`
`153`	`146`	`* @param string\|array $street`
`154`	`147`	`* @return string`
`155`	`148`	`*/`
`156`		`- public function getStreetAddress($street)`
	`149`	`+ public function getStreetAddress($street): string`
`157`	`150`	`{`
`158`	`151`	`if (is_array($street)) {`
`159`	`152`	`$street = implode(', ', $street);`
`@@ -169,7 +162,7 @@ public function getStreetAddress($street)`
`169`	`162`	`* @param string $countryCode`
`170`	`163`	`* @return string`
`171`	`164`	`*/`
`172`		`- public function getCountryByCode($countryCode)`
	`165`	`+ public function getCountryByCode($countryCode): string`
`173`	`166`	`{`
`174`	`167`	`/** @var \Magento\Directory\Model\Country $country */`
`175`	`168`	`$country = $this->countryFactory->create();`
`@@ -181,38 +174,38 @@ public function getCountryByCode($countryCode)`
`181`	`174`	`* Get default billing address`
`182`	`175`	`* Return address string if address found and null of not`
`183`	`176`	`*`
`184`		`- * @return string`
	`177`	`+ * @return int`
`185`	`178`	`* @throws \Magento\Framework\Exception\LocalizedException`
`186`	`179`	`*/`
`187`		`- private function getDefaultBilling()`
	`180`	`+ private function getDefaultBilling(): int`
`188`	`181`	`{`
`189`	`182`	`$customer = $this->getCustomer();`
`190`	`183`
`191`		`- return $customer->getDefaultBilling();`
	`184`	`+ return (int)$customer->getDefaultBilling();`
`192`	`185`	`}`
`193`	`186`
`194`	`187`
`195`	`188`	`/**`
`196`	`189`	`* Get default shipping address`
`197`	`190`	`* Return address string if address found and null of not`
`198`	`191`	`*`
`199`		`- * @return string`
	`192`	`+ * @return int`
`200`	`193`	`* @throws \Magento\Framework\Exception\LocalizedException`
`201`	`194`	`*/`
`202`		`- private function getDefaultShipping()`
	`195`	`+ private function getDefaultShipping(): int`
`203`	`196`	`{`
`204`	`197`	`$customer = $this->getCustomer();`
`205`	`198`
`206`		`- return $customer->getDefaultShipping();`
	`199`	`+ return (int)$customer->getDefaultShipping();`
`207`	`200`	`}`
`208`	`201`
`209`	`202`	`/**`
`210`	`203`	`* Get pager layout`
`211`	`204`	`*`
`212`		`- * @return void`
	`205`	`+ * @return f`
`213`	`206`	`* @throws \Magento\Framework\Exception\LocalizedException`
`214`	`207`	`*/`
`215`		`- private function preparePager()`
	`208`	`+ private function preparePager(): void`
`216`	`209`	`{`
`217`	`210`	`$addressCollection = $this->getAddressCollection();`
`218`	`211`	`if (null !== $addressCollection) {`
`@@ -232,7 +225,7 @@ private function preparePager()`
`232`	`225`	`* @return \Magento\Customer\Model\ResourceModel\Address\Collection`
`233`	`226`	`* @throws NoSuchEntityException`
`234`	`227`	`*/`
`235`		`- private function getAddressCollection()`
	`228`	`+ private function getAddressCollection(): \Magento\Customer\Model\ResourceModel\Address\Collection`
`236`	`229`	`{`
`237`	`230`	`if (null === $this->addressCollection && $this->getCustomer()) {`
`238`	`231`	`/** @var \Magento\Customer\Model\ResourceModel\Address\Collection $collection */`