🔃 [Magento Community Engineering] Community Contributions - 2.3-develop

Accepted Community Pull Requests:
 - #23118: #23053 : sendfriend verifies product visibility instead of status (by @Wirson)
 - #21605: [2.3] Database Media Storage - Admin Product Edit Page handles recreates images correctly when pub/media/catalog is cleared. (by @gwharton)
 - #23007: [Fixed] Reset feature does not clear the date (by @niravkrish)
 - #21876: $product->getUrlInStore() does not allow to override the scope in backend context (by @Nazar65)
 - #20848: Partial docs fixes in Newsletter module (by @SikailoISM)


Fixed GitHub Issues:
 - #23053: Sendfriend works for products with visibility not visible individually (reported by @TomashKhamlai) has been fixed in #23118 by @Wirson in 2.3-develop branch
   Related commits:
     1. 265e0d4
     2. 74373a0

 - #21546: [2.3] Database Media Storage - New Product Images fail to be processed correctly (reported by @gwharton) has been fixed in #21605 by @gwharton in 2.3-develop branch
   Related commits:
     1. 5f6e24f

 - #21604: Database Media Storage - Admin Product Edit page does not handle product images correctly in database storage mode (reported by @gwharton) has been fixed in #21605 by @gwharton in 2.3-develop branch
   Related commits:
     1. 5f6e24f

 - #22940: Reset feature does not clear the date (reported by @renard123) has been fixed in #23007 by @niravkrish in 2.3-develop branch
   Related commits:
     1. c9f98fc
     2. 40cc415

 - #4247: getProductUrl does not allow to override the scope in backend context (reported by @fetzi) has been fixed in #21876 by @Nazar65 in 2.3-develop branch
   Related commits:
     1. c50975a

Author: magento-engcom-team

app/code/Magento/Backend/Model/Url.php

@@ -13,6 +13,7 @@
  * Class \Magento\Backend\Model\UrlInterface
  *
  * @SuppressWarnings(PHPMD.CouplingBetweenObjects)
+ * @SuppressWarnings(PHPMD.CookieAndSessionMisuse)
  * @api
  * @since 100.0.2
  */
@@ -366,6 +367,19 @@ protected function _getMenu()
         return $this->_menu;
     }
 
+    /**
+     * Set scope entity
+     *
+     * @param mixed $scopeId
+     * @return \Magento\Framework\UrlInterface
+     */
+    public function setScope($scopeId)
+    {
+        parent::setScope($scopeId);
+        $this->_scope = $this->_scopeResolver->getScope($scopeId);
+        return $this;
+    }
+
     /**
      * Set custom auth session
      *
@@ -402,13 +416,13 @@ public function getAreaFrontName()
     }
 
     /**
-     * Retrieve action path.
-     * Add backend area front name as a prefix to action path
+     * Retrieve action path, add backend area front name as a prefix to action path
      *
      * @return string
      */
     protected function _getActionPath()
     {
+
         $path = parent::_getActionPath();
         if ($path) {
             if ($this->getAreaFrontName()) {
@@ -448,8 +462,7 @@ protected function _getConfigCacheId($path)
     }
 
     /**
-     * Get config data by path
-     * Use only global config values for backend
+     * Get config data by path, use only global config values for backend
      *
      * @param string $path
      * @return null|string

app/code/Magento/Catalog/Block/Adminhtml/Product/Helper/Form/Gallery/Content.php

@@ -19,6 +19,7 @@
 use Magento\Framework\App\Filesystem\DirectoryList;
 use Magento\Framework\Exception\FileSystemException;
 use Magento\Backend\Block\DataProviders\ImageUploadConfig as ImageUploadConfigDataProvider;
+use Magento\MediaStorage\Helper\File\Storage\Database;
 
 /**
  * Block for gallery content.
@@ -50,25 +51,34 @@ class Content extends \Magento\Backend\Block\Widget
      */
     private $imageUploadConfigDataProvider;
 
+    /**
+     * @var Database
+     */
+    private $fileStorageDatabase;
+
     /**
      * @param \Magento\Backend\Block\Template\Context $context
      * @param \Magento\Framework\Json\EncoderInterface $jsonEncoder
      * @param \Magento\Catalog\Model\Product\Media\Config $mediaConfig
      * @param array $data
      * @param ImageUploadConfigDataProvider $imageUploadConfigDataProvider
+     * @param Database $fileStorageDatabase
      */
     public function __construct(
         \Magento\Backend\Block\Template\Context $context,
         \Magento\Framework\Json\EncoderInterface $jsonEncoder,
         \Magento\Catalog\Model\Product\Media\Config $mediaConfig,
         array $data = [],
-        ImageUploadConfigDataProvider $imageUploadConfigDataProvider = null
+        ImageUploadConfigDataProvider $imageUploadConfigDataProvider = null,
+        Database $fileStorageDatabase = null
     ) {
         $this->_jsonEncoder = $jsonEncoder;
         $this->_mediaConfig = $mediaConfig;
         parent::__construct($context, $data);
         $this->imageUploadConfigDataProvider = $imageUploadConfigDataProvider
             ?: ObjectManager::getInstance()->get(ImageUploadConfigDataProvider::class);
+        $this->fileStorageDatabase = $fileStorageDatabase
+            ?: ObjectManager::getInstance()->get(Database::class);
     }
 
     /**
@@ -164,6 +174,13 @@ public function getImagesJson()
             $images = $this->sortImagesByPosition($value['images']);
             foreach ($images as &$image) {
                 $image['url'] = $this->_mediaConfig->getMediaUrl($image['file']);
+                if ($this->fileStorageDatabase->checkDbUsage() &&
+                    !$mediaDir->isFile($this->_mediaConfig->getMediaPath($image['file']))
+                ) {
+                    $this->fileStorageDatabase->saveFileToFilesystem(
+                        $this->_mediaConfig->getMediaPath($image['file'])
+                    );
+                }
                 try {
                     $fileHandler = $mediaDir->stat($this->_mediaConfig->getMediaPath($image['file']));
                     $image['size'] = $fileHandler['size'];
@@ -187,9 +204,12 @@ public function getImagesJson()
     private function sortImagesByPosition($images)
     {
         if (is_array($images)) {
-            usort($images, function ($imageA, $imageB) {
-                return ($imageA['position'] < $imageB['position']) ? -1 : 1;
-            });
+            usort(
+                $images,
+                function ($imageA, $imageB) {
+                    return ($imageA['position'] < $imageB['position']) ? -1 : 1;
+                }
+            );
         }
         return $images;
     }

app/code/Magento/Catalog/Test/Unit/Block/Adminhtml/Product/Helper/Form/Gallery/ContentTest.php

@@ -9,6 +9,7 @@
 use Magento\Catalog\Model\Entity\Attribute;
 use Magento\Catalog\Model\Product;
 use Magento\Framework\Phrase;
+use Magento\MediaStorage\Helper\File\Storage\Database;
 
 /**
  * @SuppressWarnings(PHPMD.CouplingBetweenObjects)
@@ -50,6 +51,11 @@ class ContentTest extends \PHPUnit\Framework\TestCase
      */
     protected $imageHelper;
 
+    /**
+     * @var \Magento\MediaStorage\Helper\File\Storage\Database|\PHPUnit_Framework_MockObject_MockObject
+     */
+    protected $databaseMock;
+
     /**
      * @var \Magento\Framework\TestFramework\Unit\Helper\ObjectManager
      */
@@ -71,13 +77,18 @@ public function setUp()
             ->disableOriginalConstructor()
             ->getMock();
 
+        $this->databaseMock = $this->getMockBuilder(Database::class)
+            ->disableOriginalConstructor()
+            ->getMock();
+
         $this->objectManager = new \Magento\Framework\TestFramework\Unit\Helper\ObjectManager($this);
         $this->content = $this->objectManager->getObject(
             \Magento\Catalog\Block\Adminhtml\Product\Helper\Form\Gallery\Content::class,
             [
                 'mediaConfig' => $this->mediaConfigMock,
                 'jsonEncoder' => $this->jsonEncoderMock,
-                'filesystem' => $this->fileSystemMock
+                'filesystem' => $this->fileSystemMock,
+                'fileStorageDatabase' => $this->databaseMock
             ]
         );
     }
@@ -143,6 +154,13 @@ public function testGetImagesJson()
         $this->readMock->expects($this->any())->method('stat')->willReturnMap($sizeMap);
         $this->jsonEncoderMock->expects($this->once())->method('encode')->willReturnCallback('json_encode');
 
+        $this->readMock->expects($this->any())
+            ->method('isFile')
+            ->will($this->returnValue(true));
+        $this->databaseMock->expects($this->any())
+            ->method('checkDbUsage')
+            ->will($this->returnValue(false));
+
         $this->assertSame(json_encode($imagesResult), $this->content->getImagesJson());
     }
 
@@ -210,6 +228,14 @@ public function testGetImagesJsonWithException()
         $this->fileSystemMock->expects($this->any())->method('getDirectoryRead')->willReturn($this->readMock);
         $this->mediaConfigMock->expects($this->any())->method('getMediaUrl');
         $this->mediaConfigMock->expects($this->any())->method('getMediaPath');
+
+        $this->readMock->expects($this->any())
+            ->method('isFile')
+            ->will($this->returnValue(true));
+        $this->databaseMock->expects($this->any())
+            ->method('checkDbUsage')
+            ->will($this->returnValue(false));
+
         $this->readMock->expects($this->any())->method('stat')->willReturnOnConsecutiveCalls(
             $this->throwException(
                 new \Magento\Framework\Exception\FileSystemException(new Phrase('test'))
@@ -365,4 +391,52 @@ private function getMediaAttribute(string $label, string $attributeCode)
 
         return $mediaAttribute;
     }
+
+    /**
+     * Test GetImagesJson() calls MediaStorage functions to obtain image from DB prior to stat call
+     *
+     * @return void
+     */
+    public function testGetImagesJsonMediaStorageMode()
+    {
+        $images = [
+            'images' => [
+                [
+                    'value_id' => '0',
+                    'file' => 'file_1.jpg',
+                    'media_type' => 'image',
+                    'position' => '0'
+                ]
+            ]
+        ];
+
+        $mediaPath = [
+            ['file_1.jpg', 'catalog/product/image_1.jpg']
+        ];
+
+        $this->content->setElement($this->galleryMock);
+
+        $this->galleryMock->expects($this->once())
+            ->method('getImages')
+            ->willReturn($images);
+        $this->fileSystemMock->expects($this->once())
+            ->method('getDirectoryRead')
+            ->willReturn($this->readMock);
+        $this->mediaConfigMock->expects($this->any())
+            ->method('getMediaPath')
+            ->willReturnMap($mediaPath);
+
+        $this->readMock->expects($this->any())
+            ->method('isFile')
+            ->will($this->returnValue(false));
+        $this->databaseMock->expects($this->any())
+            ->method('checkDbUsage')
+            ->will($this->returnValue(true));
+
+        $this->databaseMock->expects($this->once())
+            ->method('saveFileToFilesystem')
+            ->with('catalog/product/image_1.jpg');
+
+        $this->content->getImagesJson();
+    }
 }

app/code/Magento/Newsletter/Block/Adminhtml/Problem.php

@@ -41,7 +41,7 @@ public function __construct(
     }
 
     /**
-     * @return void
+     * @inheritDoc
      * @SuppressWarnings(PHPMD.UnusedLocalVariable)
      */
     protected function _construct()
@@ -83,7 +83,7 @@ protected function _prepareLayout()
     /**
      * Get the html element for unsubscribe button
      *
-     * @return $string
+     * @return string
      */
     public function getUnsubscribeButtonHtml()
     {
@@ -93,7 +93,7 @@ public function getUnsubscribeButtonHtml()
     /**
      * Get the html element for delete button
      *
-     * @return $string
+     * @return string
      */
     public function getDeleteButtonHtml()
     {

app/code/Magento/Newsletter/Controller/Adminhtml/Subscriber/MassDelete.php

@@ -6,22 +6,27 @@
  */
 namespace Magento\Newsletter\Controller\Adminhtml\Subscriber;
 
-use Magento\Newsletter\Controller\Adminhtml\Subscriber;
 use Magento\Backend\App\Action\Context;
+use Magento\Framework\App\Action\HttpPostActionInterface;
+use Magento\Framework\App\ObjectManager;
 use Magento\Framework\App\Response\Http\FileFactory;
+use Magento\Newsletter\Controller\Adminhtml\Subscriber;
 use Magento\Newsletter\Model\SubscriberFactory;
-use Magento\Framework\App\ObjectManager;
 
-class MassDelete extends Subscriber
+/**
+ * Subscriber mass delete controller.
+ */
+class MassDelete extends Subscriber implements HttpPostActionInterface
 {
     /**
      * @var SubscriberFactory
      */
     private $subscriberFactory;
-    
+
     /**
      * @param Context $context
      * @param FileFactory $fileFactory
+     * @param SubscriberFactory|null $subscriberFactory
      */
     public function __construct(
         Context $context,
@@ -31,7 +36,7 @@ public function __construct(
         $this->subscriberFactory = $subscriberFactory ?: ObjectManager::getInstance()->get(SubscriberFactory::class);
         parent::__construct($context, $fileFactory);
     }
-    
+
     /**
      * Delete one or more subscribers action
      *

app/code/Magento/Newsletter/Controller/Manage/Save.php

@@ -3,11 +3,12 @@
  * Copyright © Magento, Inc. All rights reserved.
  * See COPYING.txt for license details.
  */
+declare(strict_types=1);
 
 namespace Magento\Newsletter\Controller\Manage;
 
 use Magento\Customer\Api\CustomerRepositoryInterface as CustomerRepository;
-use Magento\Customer\Model\Customer;
+use Magento\Customer\Api\Data\CustomerInterface;
 use Magento\Framework\App\Action\HttpGetActionInterface;
 use Magento\Framework\App\Action\HttpPostActionInterface;
 use Magento\Newsletter\Model\Subscriber;
@@ -65,7 +66,7 @@ public function __construct(
     /**
      * Save newsletter subscription preference action
      *
-     * @return void|null
+     * @return \Magento\Framework\App\ResponseInterface
      */
     public function execute()
     {
@@ -110,16 +111,16 @@ public function execute()
                 $this->messageManager->addError(__('Something went wrong while saving your subscription.'));
             }
         }
-        $this->_redirect('customer/account/');
+        return $this->_redirect('customer/account/');
     }
 
     /**
      * Set ignore_validation_flag to skip unnecessary address and customer validation
      *
-     * @param Customer $customer
+     * @param CustomerInterface $customer
      * @return void
      */
-    private function setIgnoreValidationFlag($customer)
+    private function setIgnoreValidationFlag(CustomerInterface $customer): void
     {
         $customer->setData('ignore_validation_flag', true);
     }

app/code/Magento/Newsletter/Controller/Subscriber/Confirm.php

@@ -4,6 +4,7 @@
  * Copyright © Magento, Inc. All rights reserved.
  * See COPYING.txt for license details.
  */
+declare(strict_types=1);
 
 namespace Magento\Newsletter\Controller\Subscriber;