Merge pull request #8335 from magento-l3/PR06022023_2.4.7-beta1-develop

[L3] 2.4.7-beta1-develop

Author: viktym

app/code/Magento/Backup/Controller/Adminhtml/Index/Download.php

@@ -6,9 +6,10 @@
  */
 namespace Magento\Backup\Controller\Adminhtml\Index;
 
+use Magento\Framework\App\Action\HttpGetActionInterface;
 use Magento\Framework\App\Filesystem\DirectoryList;
 
-class Download extends \Magento\Backup\Controller\Adminhtml\Index
+class Download extends \Magento\Backup\Controller\Adminhtml\Index implements HttpGetActionInterface
 {
     /**
      * @var \Magento\Framework\Controller\Result\RawFactory
@@ -66,17 +67,12 @@ public function execute()
 
         $fileName = $this->_objectManager->get(\Magento\Backup\Helper\Data::class)->generateBackupDownloadName($backup);
 
-        $this->_fileFactory->create(
+        return $this->_fileFactory->create(
             $fileName,
-            null,
+            ['type' => 'filename', 'value' => $backup->getPath() . DIRECTORY_SEPARATOR . $backup->getFileName()],
             DirectoryList::VAR_DIR,
             'application/octet-stream',
             $backup->getSize()
         );
-
-        /** @var \Magento\Framework\Controller\Result\Raw $resultRaw */
-        $resultRaw = $this->resultRawFactory->create();
-        $resultRaw->setContents($backup->output());
-        return $resultRaw;
     }
 }

app/code/Magento/Backup/Test/Unit/Controller/Adminhtml/Index/DownloadTest.php

@@ -115,7 +115,7 @@ protected function setUp(): void
             ->getMock();
         $this->backupModelMock = $this->getMockBuilder(Backup::class)
             ->disableOriginalConstructor()
-            ->setMethods(['getTime', 'exists', 'getSize', 'output'])
+            ->setMethods(['getTime', 'exists', 'getSize', 'output', 'getPath', 'getFileName'])
             ->getMock();
         $this->dataHelperMock = $this->getMockBuilder(Data::class)
             ->disableOriginalConstructor()
@@ -169,8 +169,13 @@ public function testExecuteBackupFound()
         $type = 'db';
         $filename = 'filename';
         $size = 10;
-        $output = 'test';
-
+        $path = 'testpath';
+        $this->backupModelMock->expects($this->atLeastOnce())
+            ->method('getPath')
+            ->willReturn($path);
+        $this->backupModelMock->expects($this->atLeastOnce())
+            ->method('getFileName')
+            ->willReturn($filename);
         $this->backupModelMock->expects($this->atLeastOnce())
             ->method('getTime')
             ->willReturn($time);
@@ -180,9 +185,6 @@ public function testExecuteBackupFound()
         $this->backupModelMock->expects($this->atLeastOnce())
             ->method('getSize')
             ->willReturn($size);
-        $this->backupModelMock->expects($this->atLeastOnce())
-            ->method('output')
-            ->willReturn($output);
         $this->requestMock->expects($this->any())
             ->method('getParam')
             ->willReturnMap(
@@ -206,20 +208,14 @@ public function testExecuteBackupFound()
         $this->fileFactoryMock->expects($this->once())
             ->method('create')->with(
                 $filename,
-                null,
+                ['type' => 'filename', 'value' => $path . '/' . $filename],
                 DirectoryList::VAR_DIR,
                 'application/octet-stream',
                 $size
             )
             ->willReturn($this->responseMock);
-        $this->resultRawMock->expects($this->once())
-            ->method('setContents')
-            ->with($output);
-        $this->resultRawFactoryMock->expects($this->once())
-            ->method('create')
-            ->willReturn($this->resultRawMock);
 
-        $this->assertSame($this->resultRawMock, $this->downloadController->execute());
+        $this->assertSame($this->responseMock, $this->downloadController->execute());
     }
 
     /**

app/code/Magento/ImportExport/Controller/Adminhtml/History/Download.php

@@ -7,6 +7,7 @@
 
 use Magento\Framework\App\Action\HttpGetActionInterface;
 use Magento\Framework\App\Filesystem\DirectoryList;
+use Magento\ImportExport\Model\Import;
 
 /**
  * Download history controller
@@ -47,6 +48,7 @@ public function __construct(
      */
     public function execute()
     {
+        // phpcs:ignore Magento2.Functions.DiscouragedFunction
         $fileName = basename($this->getRequest()->getParam('filename'));
 
         /** @var \Magento\ImportExport\Helper\Report $reportHelper */
@@ -59,17 +61,12 @@ public function execute()
             return $resultRedirect;
         }
 
-        $this->fileFactory->create(
+        return $this->fileFactory->create(
             $fileName,
-            null,
+            ['type' => 'filename', 'value' => Import::IMPORT_HISTORY_DIR . $fileName],
             DirectoryList::VAR_IMPORT_EXPORT,
             'application/octet-stream',
             $reportHelper->getReportSize($fileName)
         );
-
-        /** @var \Magento\Framework\Controller\Result\Raw $resultRaw */
-        $resultRaw = $this->resultRawFactory->create();
-        $resultRaw->setContents($reportHelper->getReportOutput($fileName));
-        return $resultRaw;
     }
 }

app/code/Magento/ImportExport/Test/Unit/Controller/Adminhtml/History/DownloadTest.php

@@ -9,14 +9,17 @@
 
 use Magento\Backend\App\Action\Context;
 use Magento\Backend\Model\View\Result\Redirect;
+use Magento\Framework\App\Filesystem\DirectoryList;
 use Magento\Framework\App\Request\Http;
 use Magento\Framework\App\Response\Http\FileFactory;
+use Magento\Framework\App\ResponseInterface;
 use Magento\Framework\Controller\Result\Raw;
 use Magento\Framework\Controller\Result\RawFactory;
 use Magento\Framework\Controller\Result\RedirectFactory;
 use Magento\Framework\TestFramework\Unit\Helper\ObjectManager as ObjectManagerHelper;
 use Magento\ImportExport\Controller\Adminhtml\History\Download;
 use Magento\ImportExport\Helper\Report;
+use Magento\ImportExport\Model\Import;
 use PHPUnit\Framework\MockObject\MockObject;
 use PHPUnit\Framework\TestCase;
 
@@ -155,8 +158,20 @@ public function testExecute($requestFilename, $processedFilename)
         $this->reportHelper->method('importFileExists')
             ->with($processedFilename)
             ->willReturn(true);
-        $this->resultRaw->expects($this->once())->method('setContents');
-        $this->downloadController->execute();
+
+        $responseMock = $this->getMockBuilder(ResponseInterface::class)
+            ->getMock();
+        $this->fileFactory->expects($this->once())
+            ->method('create')
+            ->with(
+                $processedFilename,
+                ['type' => 'filename', 'value' =>Import::IMPORT_HISTORY_DIR . $processedFilename],
+                DirectoryList::VAR_IMPORT_EXPORT,
+                'application/octet-stream',
+                1
+            )
+            ->willReturn($responseMock);
+        $this->assertSame($responseMock, $this->downloadController->execute());
     }
 
     /**

app/code/Magento/PageCache/Model/App/FrontController/BuiltinPlugin.php

@@ -5,6 +5,7 @@
  */
 namespace Magento\PageCache\Model\App\FrontController;
 
+use Magento\Framework\App\PageCache\NotCacheableInterface;
 use Magento\Framework\App\Response\Http as ResponseHttp;
 
 /**
@@ -73,7 +74,7 @@ public function aroundDispatch(
         $result = $this->kernel->load();
         if ($result === false) {
             $result = $proceed($request);
-            if ($result instanceof ResponseHttp) {
+            if ($result instanceof ResponseHttp && !$result instanceof NotCacheableInterface) {
                 $this->addDebugHeaders($result);
                 $this->kernel->process($result);
             }

app/code/Magento/PageCache/Test/Unit/Model/App/FrontController/BuiltinPluginTest.php

@@ -11,6 +11,7 @@
 use Laminas\Http\Header\GenericHeader;
 use Magento\Framework\App\FrontControllerInterface;
 use Magento\Framework\App\PageCache\Kernel;
+use Magento\Framework\App\PageCache\NotCacheableInterface;
 use Magento\Framework\App\PageCache\Version;
 use Magento\Framework\App\RequestInterface;
 use Magento\Framework\App\Response\Http;
@@ -243,6 +244,41 @@ public function testAroundDispatchDisabled($state): void
         );
     }
 
+    /**
+     * @return void
+     */
+    public function testAroundNotCacheableResponse(): void
+    {
+        $this->configMock
+            ->expects($this->once())
+            ->method('getType')
+            ->willReturn(Config::BUILT_IN);
+        $this->configMock->expects($this->once())
+            ->method('isEnabled')
+            ->willReturn(true);
+        $this->versionMock
+            ->expects($this->once())
+            ->method('process');
+        $this->kernelMock->expects($this->once())
+            ->method('load')
+            ->willReturn(false);
+        $this->stateMock->expects($this->never())
+            ->method('getMode');
+        $this->kernelMock->expects($this->never())
+            ->method('process');
+        $this->responseMock->expects($this->never())
+            ->method('setHeader');
+        $notCacheableResponse = $this->createMock(NotCacheableInterface::class);
+        $this->assertSame(
+            $notCacheableResponse,
+            $this->plugin->aroundDispatch(
+                $this->frontControllerMock,
+                fn () => $notCacheableResponse,
+                $this->requestMock
+            )
+        );
+    }
+
     /**
      * @return array
      */

app/code/Magento/Sales/Controller/Download/DownloadCustomOption.php

@@ -29,6 +29,8 @@ class DownloadCustomOption extends \Magento\Framework\App\Action\Action implemen
     /**
      * @var \Magento\Framework\Unserialize\Unserialize
      * @deprecated 101.0.0
+     * @deprecated No longer used
+     * @see $serializer
      */
     protected $unserialize;
 
@@ -106,7 +108,7 @@ public function execute()
             if ($this->getRequest()->getParam('key') != $info['secret_key']) {
                 return $resultForward->forward('noroute');
             }
-            $this->download->downloadFile($info);
+            return $this->download->createResponse($info);
         } catch (\Exception $e) {
             return $resultForward->forward('noroute');
         }

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

@@ -67,8 +67,22 @@ public function __construct(
      * @param array $info
      * @return void
      * @throws \Exception
+     * @deprecated No longer recommended
+     * @see createResponse()
      */
     public function downloadFile($info)
+    {
+        $this->createResponse($info);
+    }
+
+    /**
+     * Returns a file response
+     *
+     * @param array $info
+     * @return \Magento\Framework\App\ResponseInterface
+     * @throws \Exception
+     */
+    public function createResponse($info)
     {
         $relativePath = $info['order_path'];
         if (!$this->_isCanProcessed($relativePath)) {
@@ -80,7 +94,7 @@ public function downloadFile($info)
                 );
             }
         }
-        $this->_fileFactory->create(
+        return $this->_fileFactory->create(
             $info['title'],
             ['value' => $this->_rootDir->getRelativePath($relativePath), 'type' => 'filename'],
             $this->rootDirBasePath,

app/code/Magento/Sales/Test/Unit/Controller/Download/DownloadCustomOptionTest.php

@@ -9,6 +9,7 @@
 
 use Magento\Backend\App\Action\Context;
 use Magento\Framework\App\Request\Http;
+use Magento\Framework\App\ResponseInterface;
 use Magento\Framework\Controller\Result\Forward;
 use Magento\Framework\Controller\Result\ForwardFactory;
 use Magento\Framework\Serialize\Serializer\Json;
@@ -24,32 +25,32 @@ class DownloadCustomOptionTest extends TestCase
     /**
      * Option ID Test Value
      */
-    const OPTION_ID = '123456';
+    public const OPTION_ID = '123456';
 
     /**
      * Option Code Test Value
      */
-    const OPTION_CODE = 'option_123456';
+    public const OPTION_CODE = 'option_123456';
 
     /**
      * Option Product ID Value
      */
-    const OPTION_PRODUCT_ID = 'option_test_product_id';
+    public const OPTION_PRODUCT_ID = 'option_test_product_id';
 
     /**
      * Option Type Value
      */
-    const OPTION_TYPE = 'file';
+    public const OPTION_TYPE = 'file';
 
     /**
      * Option Value Test Value
      */
-    const OPTION_VALUE = 'option_test_value';
+    public const OPTION_VALUE = 'option_test_value';
 
     /**
      * Option Value Test Value
      */
-    const SECRET_KEY = 'secret_key';
+    public const SECRET_KEY = 'secret_key';
 
     /**
      * @var \Magento\Quote\Model\Quote\Item\Option|MockObject
@@ -95,7 +96,7 @@ protected function setUp(): void
 
         $this->downloadMock = $this->getMockBuilder(Download::class)
             ->disableOriginalConstructor()
-            ->setMethods(['downloadFile'])
+            ->setMethods(['createResponse'])
             ->getMock();
 
         $this->serializerMock = $this->getMockBuilder(Json::class)
@@ -199,7 +200,8 @@ public function testExecute($itemOptionValues, $productOptionValues, $noRouteOcc
                 ->willReturn($productOptionValues[self::OPTION_TYPE]);
         }
         if ($noRouteOccurs) {
-            $this->resultForwardMock->expects($this->once())->method('forward')->with('noroute')->willReturn(true);
+            $result = $this->resultForwardMock;
+            $this->resultForwardMock->expects($this->once())->method('forward')->with('noroute')->willReturnSelf();
         } else {
             $unserializeResult = [self::SECRET_KEY => self::SECRET_KEY];
 
@@ -208,14 +210,15 @@ public function testExecute($itemOptionValues, $productOptionValues, $noRouteOcc
                 ->with($itemOptionValues[self::OPTION_VALUE])
                 ->willReturn($unserializeResult);
 
+            $result = $this->getMockBuilder(ResponseInterface::class)
+                ->getMock();
             $this->downloadMock->expects($this->once())
-                ->method('downloadFile')
+                ->method('createResponse')
                 ->with($unserializeResult)
-                ->willReturn(true);
+                ->willReturn($result);
 
-            $this->objectMock->expects($this->once())->method('endExecute')->willReturn(true);
         }
-        $this->objectMock->execute();
+        $this->assertSame($result, $this->objectMock->execute());
     }
 
     /**

app/code/Magento/Wishlist/Controller/Index/DownloadCustomOption.php

@@ -97,7 +97,7 @@ public function execute()
             $secretKey = $this->getRequest()->getParam('key');
 
             if ($secretKey == $info['secret_key']) {
-                $this->_fileResponseFactory->create(
+                return $this->_fileResponseFactory->create(
                     $info['title'],
                     ['value' => $info['quote_path'], 'type' => 'filename'],
                     DirectoryList::MEDIA,