MC-35407: Advance Reporting generated csv files are not properly escaped which causes reports to fail on MBI side.

Author: tsviklinskyi

app/code/Magento/Analytics/Model/ReportWriter.php

@@ -3,14 +3,15 @@
  * Copyright © Magento, Inc. All rights reserved.
  * See COPYING.txt for license details.
  */
+declare(strict_types=1);
+
 namespace Magento\Analytics\Model;
 
 use Magento\Analytics\ReportXml\DB\ReportValidator;
 use Magento\Framework\Filesystem\Directory\WriteInterface;
 
 /**
  * Writes reports in files in csv format
- * @inheritdoc
  */
 class ReportWriter implements ReportWriterInterface
 {
@@ -54,7 +55,7 @@ public function __construct(
     }
 
     /**
-     * {@inheritdoc}
+     * @inheritdoc
      */
     public function write(WriteInterface $directory, $path)
     {
@@ -81,7 +82,7 @@ public function write(WriteInterface $directory, $path)
                     $headers = array_keys($row);
                     $stream->writeCsv($headers);
                 }
-                $stream->writeCsv($row);
+                $stream->writeCsv($this->prepareRow($row));
             }
             $stream->unlock();
             $stream->close();
@@ -98,4 +99,18 @@ public function write(WriteInterface $directory, $path)
 
         return true;
     }
+
+    /**
+     * Replace wrong symbols in row
+     *
+     * @param array $row
+     * @return array
+     */
+    private function prepareRow(array $row): array
+    {
+        $row = preg_replace('/(?<!\\\\)"/', '\\"', $row);
+        $row = preg_replace('/[\\\\]+/', '\\', $row);
+
+        return $row;
+    }
 }

app/code/Magento/Analytics/Test/Unit/Model/ReportWriterTest.php

@@ -12,7 +12,8 @@
 use Magento\Analytics\Model\ReportWriter;
 use Magento\Analytics\ReportXml\DB\ReportValidator;
 use Magento\Analytics\ReportXml\ReportProvider;
-use Magento\Framework\Filesystem\Directory\WriteInterface;
+use Magento\Framework\Filesystem\Directory\WriteInterface as DirectoryWriteInterface;
+use Magento\Framework\Filesystem\File\WriteInterface as FileWriteInterface;
 use Magento\Framework\TestFramework\Unit\Helper\ObjectManager as ObjectManagerHelper;
 use PHPUnit\Framework\MockObject\MockObject;
 use PHPUnit\Framework\TestCase;
@@ -48,7 +49,7 @@ class ReportWriterTest extends TestCase
     private $objectManagerHelper;
 
     /**
-     * @var WriteInterface|MockObject
+     * @var DirectoryWriteInterface|MockObject
      */
     private $directoryMock;
 
@@ -82,7 +83,7 @@ protected function setUp(): void
         $this->reportValidatorMock = $this->createMock(ReportValidator::class);
         $this->providerFactoryMock = $this->createMock(ProviderFactory::class);
         $this->reportProviderMock = $this->createMock(ReportProvider::class);
-        $this->directoryMock = $this->getMockBuilder(WriteInterface::class)
+        $this->directoryMock = $this->getMockBuilder(DirectoryWriteInterface::class)
             ->getMockForAbstractClass();
         $this->objectManagerHelper = new ObjectManagerHelper($this);
 
@@ -98,16 +99,15 @@ protected function setUp(): void
 
     /**
      * @param array $configData
+     * @param array $fileData
+     * @param array $expectedFileData
      * @return void
      *
      * @dataProvider configDataProvider
      */
-    public function testWrite(array $configData)
+    public function testWrite(array $configData, array $fileData, array $expectedFileData): void
     {
         $errors = [];
-        $fileData = [
-            ['number' => 1, 'type' => 'Shoes Usual']
-        ];
         $this->configInterfaceMock
             ->expects($this->once())
             ->method('get')
@@ -126,7 +126,7 @@ public function testWrite(array $configData)
             ->with($parameterName ?: null)
             ->willReturn($fileData);
         $errorStreamMock = $this->getMockBuilder(
-            \Magento\Framework\Filesystem\File\WriteInterface::class
+            FileWriteInterface::class
         )->getMockForAbstractClass();
         $errorStreamMock
             ->expects($this->once())
@@ -136,8 +136,8 @@ public function testWrite(array $configData)
             ->expects($this->exactly(2))
             ->method('writeCsv')
             ->withConsecutive(
-                [array_keys($fileData[0])],
-                [$fileData[0]]
+                [array_keys($expectedFileData[0])],
+                [$expectedFileData[0]]
             );
         $errorStreamMock->expects($this->once())->method('unlock');
         $errorStreamMock->expects($this->once())->method('close');
@@ -164,12 +164,12 @@ public function testWrite(array $configData)
      *
      * @dataProvider configDataProvider
      */
-    public function testWriteErrorFile($configData)
+    public function testWriteErrorFile(array $configData): void
     {
         $errors = ['orders', 'SQL Error: test'];
         $this->configInterfaceMock->expects($this->once())->method('get')->willReturn([$configData]);
         $errorStreamMock = $this->getMockBuilder(
-            \Magento\Framework\Filesystem\File\WriteInterface::class
+            FileWriteInterface::class
         )->getMockForAbstractClass();
         $errorStreamMock->expects($this->once())->method('lock');
         $errorStreamMock->expects($this->once())->method('writeCsv')->with($errors);
@@ -184,7 +184,7 @@ public function testWriteErrorFile($configData)
     /**
      * @return void
      */
-    public function testWriteEmptyReports()
+    public function testWriteEmptyReports(): void
     {
         $this->configInterfaceMock->expects($this->once())->method('get')->willReturn([]);
         $this->reportValidatorMock->expects($this->never())->method('validate');
@@ -195,11 +195,11 @@ public function testWriteEmptyReports()
     /**
      * @return array
      */
-    public function configDataProvider()
+    public function configDataProvider(): array
     {
         return [
             'reportProvider' => [
-                [
+                'configData' => [
                     'providers' => [
                         [
                             'name' => $this->providerName,
@@ -209,6 +209,12 @@ public function configDataProvider()
                             ],
                         ]
                     ]
+                ],
+                'fileData' => [
+                    ['number' => 1, 'type' => 'Shoes\"" Usual\\\\"']
+                ],
+                'expectedFileData' => [
+                    ['number' => 1, 'type' => 'Shoes\"\" Usual\\"']
                 ]
             ],
         ];