ACP2E-1627: [Cloud] Magento Product Recommendation/Data Services Causing File Download Warning

Author: bubasuma

dev/tests/integration/testsuite/Magento/Framework/App/Filesystem/CreatePdfFileTest.php

@@ -34,6 +34,9 @@ public function testGenerateFileFromString()
         $contentType = 'application/pdf';
         $fileContent = ['type' => 'string', 'value' => ''];
         $response = $fileFactory->create($filename, $fileContent, DirectoryList::VAR_DIR, $contentType);
+        ob_start();
+        $response->sendResponse();
+        ob_end_clean();
         /** @var ContentType $contentTypeHeader */
         $contentTypeHeader = $response->getHeader('Content-type');
 
@@ -48,7 +51,10 @@ public function testGenerateFileFromString()
 
         /* Check the file is removed after generation if the corresponding option is set */
         $fileContent = ['type' => 'string', 'value' => '', 'rm' => true];
-        $fileFactory->create($filename, $fileContent, DirectoryList::VAR_DIR, $contentType);
+        $response = $fileFactory->create($filename, $fileContent, DirectoryList::VAR_DIR, $contentType);
+        ob_start();
+        $response->sendResponse();
+        ob_end_clean();
 
         self::assertFalse($varDirectory->isFile($filename));
     }

lib/internal/Magento/Framework/App/Response/File.php

@@ -7,9 +7,12 @@
 
 namespace Magento\Framework\App\Response;
 
+use InvalidArgumentException;
 use Magento\Framework\App\Filesystem\DirectoryList;
 use Magento\Framework\App\Http\Context;
+use Magento\Framework\App\PageCache\NotCacheableInterface;
 use Magento\Framework\App\Request\Http as HttpRequest;
+use Magento\Framework\Exception\FileSystemException;
 use Magento\Framework\Filesystem;
 use Magento\Framework\Filesystem\Driver\File\Mime;
 use Magento\Framework\Session\Config\ConfigInterface;
@@ -20,7 +23,7 @@
 /**
  * @SuppressWarnings(PHPMD.CookieAndSessionMisuse)
  */
-class File extends Http
+class File extends Http implements NotCacheableInterface
 {
     /**
      * @var Http
@@ -63,6 +66,7 @@ class File extends Http
      * @param Mime $mime
      * @param array $fileOptions
      * @SuppressWarnings(PHPMD.ExcessiveParameterList)
+     * @throws FileSystemException
      */
     public function __construct(
         HttpRequest $request,
@@ -81,45 +85,36 @@ public function __construct(
         $this->response = $response;
         $this->mime = $mime;
         $this->fileOptions = array_merge($this->fileOptions, $fileOptions);
+        if (!isset($this->fileOptions['filePath'])) {
+            throw new InvalidArgumentException("File path is required");
+        }
+        $dir = $this->filesystem->getDirectoryRead($this->fileOptions['directoryCode']);
+        if (!$dir->isExist($this->fileOptions['filePath'])) {
+            throw new InvalidArgumentException("File '{$this->fileOptions['filePath']}' does not exists.");
+        }
+        $this->setFileHeaders();
     }
 
     /**
      * @inheritDoc
      */
     public function sendResponse()
     {
-        if ($this->fileOptions['filePath']) {
+        $this->response->sendHeaders();
+
+        if (!$this->request->isHead()) {
             $dir = $this->filesystem->getDirectoryWrite($this->fileOptions['directoryCode']);
             $filePath = $this->fileOptions['filePath'];
-            $contentType = $this->fileOptions['contentType']
-                ?? $dir->stat($filePath)['mimeType']
-                ?? $this->mime->getMimeType($dir->getAbsolutePath($filePath));
-            $contentLength = $this->fileOptions['contentLength']
-                ?? $dir->stat($filePath)['size'];
-            $fileName = $this->fileOptions['fileName']
-                ?? basename($filePath);
-            $this->response->setHttpResponseCode(200);
-            $this->response->setHeader('Content-type', $contentType, true)
-                ->setHeader('Content-Length', $contentLength)
-                ->setHeader('Content-Disposition', 'attachment; filename="' . $fileName . '"', true)
-                ->setHeader('Pragma', 'public', true)
-                ->setHeader('Cache-Control', 'must-revalidate, post-check=0, pre-check=0', true)
-                ->setHeader('Last-Modified', date('r'), true);
-
-            $this->response->sendHeaders();
-
-            if (!$this->request->isHead()) {
-                $stream = $dir->openFile($filePath, 'r');
-                while (!$stream->eof()) {
-                    // phpcs:ignore Magento2.Security.LanguageConstruct.DirectOutput
-                    echo $stream->read(1024);
-                }
-                $stream->close();
-                if ($this->fileOptions['remove']) {
-                    $dir->delete($filePath);
-                }
-                $this->response->clearBody();
+            $stream = $dir->openFile($filePath, 'r');
+            while (!$stream->eof()) {
+                // phpcs:ignore Magento2.Security.LanguageConstruct.DirectOutput
+                echo $stream->read(1024);
+            }
+            $stream->close();
+            if ($this->fileOptions['remove']) {
+                $dir->delete($filePath);
             }
+            $this->response->clearBody();
         }
         return $this;
     }
@@ -148,4 +143,30 @@ public function clearHeader($name)
     {
         return $this->response->clearHeader($name);
     }
+
+    /**
+     * Set appropriate headers for the file attachment
+     *
+     * @return void
+     * @throws \Magento\Framework\Exception\FileSystemException
+     */
+    private function setFileHeaders(): void
+    {
+        $dir = $this->filesystem->getDirectoryWrite($this->fileOptions['directoryCode']);
+        $filePath = $this->fileOptions['filePath'];
+        $contentType = $this->fileOptions['contentType']
+            ?? $dir->stat($filePath)['mimeType']
+            ?? $this->mime->getMimeType($dir->getAbsolutePath($filePath));
+        $contentLength = $this->fileOptions['contentLength']
+            ?? $dir->stat($filePath)['size'];
+        $fileName = $this->fileOptions['fileName']
+            ?? basename($filePath);
+        $this->response->setHttpResponseCode(200);
+        $this->response->setHeader('Content-type', $contentType, true)
+            ->setHeader('Content-Length', $contentLength)
+            ->setHeader('Content-Disposition', 'attachment; filename="' . $fileName . '"', true)
+            ->setHeader('Pragma', 'public', true)
+            ->setHeader('Cache-Control', 'must-revalidate, post-check=0, pre-check=0', true)
+            ->setHeader('Last-Modified', date('r'), true);
+    }
 }