updated new files from master

landofcoder · landofcoder · commit eaa4b87ecb14 · 2021-11-05T14:45:12.000+07:00
diff --git a/Config/Config.php b/Config/Config.php
@@ -4,7 +4,11 @@
 namespace Lof\Webp2\Config;
 
 use Magento\Framework\App\Config\ScopeConfigInterface;
+use Magento\Framework\Exception\NoSuchEntityException;
 use Magento\Framework\View\Element\Block\ArgumentInterface;
+use Magento\Store\Model\ScopeInterface;
+use Magento\Store\Model\StoreManagerInterface;
+use Lof\Webp2\Exception\InvalidConvertorException;
 
 class Config implements ArgumentInterface
 {
@@ -13,31 +17,39 @@ class Config implements ArgumentInterface
      */
     private $scopeConfig;
 
+    /**
+     * @var StoreManagerInterface
+     */
+    private $storeManager;
+
     /**
      * Config constructor.
      *
      * @param ScopeConfigInterface $scopeConfig
+     * @param StoreManagerInterface $storeManager
      */
     public function __construct(
-        ScopeConfigInterface $scopeConfig
+        ScopeConfigInterface $scopeConfig,
+        StoreManagerInterface $storeManager
     ) {
         $this->scopeConfig = $scopeConfig;
+        $this->storeManager = $storeManager;
     }
 
     /**
      * @return bool
      */
     public function enabled(): bool
     {
-        return (bool)$this->scopeConfig->getValue('lof_webp2/settings/enabled');
+        return (bool)$this->getValue('lof_webp2/settings/enabled');
     }
 
     /**
      * @return int
      */
     public function getQualityLevel(): int
     {
-        $qualityLevel = (int)$this->scopeConfig->getValue('lof_webp2/settings/quality_level');
+        $qualityLevel = (int)$this->getValue('lof_webp2/settings/quality_level');
         if ($qualityLevel > 100) {
             return 100;
         }
@@ -51,9 +63,77 @@ public function getQualityLevel(): int
 
     /**
      * @return string[]
+     * @throws InvalidConvertorException
      */
     public function getConvertors(): array
     {
-        return ['cwebp', 'gd', 'imagick', 'wpc', 'ewww'];
+        $allConvertors = ['cwebp', 'gd', 'imagick', 'wpc', 'ewww'];
+        $storedConvertors = $this->getValue('lof_webp2/settings/convertors');
+        $storedConvertors = $this->stringToArray((string)$storedConvertors);
+        if (empty($storedConvertors)) {
+            return $allConvertors;
+        }
+
+        foreach ($storedConvertors as $storedConvertor) {
+            if (!in_array($storedConvertor, $allConvertors)) {
+                throw new InvalidConvertorException('Invalid convertor: "' . $storedConvertor . '"');
+            }
+        }
+
+        return $storedConvertors;
+    }
+
+    /**
+     * @return string
+     * @throws InvalidConvertorException
+     */
+    public function getEncoding(): string
+    {
+        $allEncoding = ['lossy', 'lossless', 'auto'];
+        $storedEncoding = (string)$this->getValue('lof_webp2/settings/encoding');
+        if (empty($storedEncoding)) {
+            return 'lossy';
+        }
+
+        if (!in_array($storedEncoding, $allEncoding)) {
+            throw new InvalidConvertorException('Invalid encoding: "' . $storedEncoding . '"');
+        }
+
+        return $storedEncoding;
+    }
+
+    /**
+     * @param string $path
+     * @return mixed
+     */
+    private function getValue(string $path)
+    {
+        try {
+            return $this->scopeConfig->getValue(
+                $path,
+                ScopeInterface::SCOPE_STORE,
+                $this->storeManager->getStore()
+            );
+        } catch (NoSuchEntityException $e) {
+            return null;
+        }
+    }
+
+    /**
+     * @param string $string
+     * @return array
+     */
+    private function stringToArray(string $string): array
+    {
+        $array = [];
+        $strings = explode(',', $string);
+        foreach ($strings as $string) {
+            $string = trim($string);
+            if ($string) {
+                $array[] = $string;
+            }
+        }
+
+        return $array;
     }
 }
diff --git a/Convertor/ConvertWrapper.php b/Convertor/ConvertWrapper.php
@@ -1,11 +1,13 @@
 <?php
 declare(strict_types=1);
 
-namespace Lof\Webp2\Image;
+namespace Lof\Webp2\Convertor;
 
+use WebPConvert\Convert\Exceptions\ConversionFailed\InvalidInput\InvalidImageTypeException;
 use WebPConvert\Convert\Exceptions\ConversionFailedException;
 use WebPConvert\WebPConvert;
 use Lof\Webp2\Config\Config;
+use Lof\Webp2\Exception\InvalidConvertorException;
 
 /**
  * Class ConvertWrapper to wrap third party wrapper for purpose of preference overrides and testing
@@ -31,21 +33,25 @@ public function __construct(
      * @param string $sourceImageFilename
      * @param string $destinationImageFilename
      * @throws ConversionFailedException
+     * @throws InvalidConvertorException
+     * @throws InvalidImageTypeException
      */
     public function convert(string $sourceImageFilename, string $destinationImageFilename): void
     {
         WebPConvert::convert($sourceImageFilename, $destinationImageFilename, $this->getOptions());
     }
 
     /**
-     * @return mixed[]
+     * @return array
+     * @throws InvalidConvertorException
      */
     public function getOptions(): array
     {
         return [
             'quality' => 'auto',
             'max-quality' => $this->config->getQualityLevel(),
             'converters' => $this->config->getConvertors(),
+            'encoding' => $this->config->getEncoding(),
         ];
     }
 }
diff --git a/Convertor/Convertor.php b/Convertor/Convertor.php
@@ -2,8 +2,11 @@
 
 namespace Lof\Webp2\Convertor;
 
+use Magento\Framework\Exception\FileSystemException;
+use Magento\Framework\Exception\NoSuchEntityException;
 use Magento\Framework\Filesystem\Driver\File as FileDriver;
 use Magento\Framework\Filesystem\File\ReadFactory as FileReadFactory;
+use WebPConvert\Convert\Exceptions\ConversionFailed\InvalidInput\InvalidImageTypeException;
 use WebPConvert\Convert\Exceptions\ConversionFailedException;
 use Lof\NextGenImages\Convertor\ConvertorInterface;
 use Lof\NextGenImages\Exception\ConvertorException;
@@ -12,7 +15,8 @@
 use Lof\NextGenImages\Image\SourceImageFactory;
 use Lof\NextGenImages\Logger\Debugger;
 use Lof\Webp2\Config\Config;
-use Lof\Webp2\Image\ConvertWrapper;
+use Lof\Webp2\Exception\InvalidConvertorException;
+use WebPConvert\Exceptions\InvalidInput\InvalidImageTypeException as InvalidInputImageTypeException;
 
 class Convertor implements ConvertorInterface
 {
@@ -83,6 +87,8 @@ public function __construct(
      * @param string $imageUrl
      * @return SourceImage
      * @throws ConvertorException
+     * @throws FileSystemException
+     * @throws NoSuchEntityException
      * @deprecated Use getSourceImage() instead
      */
     public function convertByUrl(string $imageUrl): SourceImage
@@ -94,6 +100,8 @@ public function convertByUrl(string $imageUrl): SourceImage
      * @param string $imageUrl
      * @return SourceImage
      * @throws ConvertorException
+     * @throws FileSystemException
+     * @throws NoSuchEntityException
      */
     public function getSourceImage(string $imageUrl): SourceImage
     {
@@ -126,10 +134,10 @@ public function convert(string $sourceImageUri, ?string $destinationImageUri = n
         $sourceImageFilename = $this->imageFile->resolve($sourceImageUri);
         $destinationImageFilename = $this->imageFile->resolve($destinationImageUri);
 
-        if(!$this->imageFile->fileExists($sourceImageFilename)) {
+        if (!$this->imageFile->fileExists($sourceImageFilename)) {
             throw new ConvertorException('Source cached image does not exists ' . $sourceImageUri);
         }
-        
+
         if (!$this->imageFile->needsConversion($sourceImageFilename, $destinationImageFilename)) {
             return true;
         }
@@ -140,7 +148,9 @@ public function convert(string $sourceImageUri, ?string $destinationImageUri = n
 
         try {
             $this->convertWrapper->convert($sourceImageFilename, $destinationImageFilename);
-        } catch (ConversionFailedException $e) {
+        } catch (InvalidImageTypeException | InvalidInputImageTypeException $e) {
+            return false;
+        } catch (ConversionFailedException | InvalidConvertorException $e) {
             throw new ConvertorException($destinationImageFilename . ': ' . $e->getMessage());
         }
 
diff --git a/Exception/InvalidConvertorException.php b/Exception/InvalidConvertorException.php
@@ -0,0 +1,9 @@
+<?php declare(strict_types=1);
+
+namespace Lof\Webp2\Exception;
+
+use Exception;
+
+class InvalidConvertorException extends Exception
+{
+}
diff --git a/Model/Config/Source/Encoding.php b/Model/Config/Source/Encoding.php
@@ -0,0 +1,17 @@
+<?php declare(strict_types=1);
+
+namespace Lof\Webp2\Model\Config\Source;
+
+use Magento\Framework\Data\OptionSourceInterface;
+
+class Encoding implements OptionSourceInterface
+{
+    public function toOptionArray()
+    {
+        return [
+            ['value' => 'lossy', 'label' => 'Lossy'],
+            ['value' => 'lossless', 'label' => 'Lossless'],
+            ['value' => 'auto', 'label' => 'Auto (both lossy and lossless)'],
+        ];
+    }
+}
diff --git a/Plugin/AddWebpToGalleryImagesJson.php b/Plugin/AddWebpToGalleryImagesJson.php
@@ -59,9 +59,12 @@ public function afterGetGalleryImagesJson(Gallery $subject, string $galleryImage
     private function appendImages(array $images): array
     {
         foreach ($images as $id => $imageData) {
-            $imageData['thumb_webp'] = $this->getWebpUrl($imageData['thumb']);
-            $imageData['img_webp'] = $this->getWebpUrl($imageData['img']);
-            $imageData['full_webp'] = $this->getWebpUrl($imageData['full']);
+            foreach (['thumb', 'img', 'full'] as $imageType) {
+                if (empty($imageData[$imageType])) {
+                    continue;
+                }
+                $imageData["{$imageType}_webp"] = $this->getWebpUrl($imageData[$imageType]);
+            }
             $images[$id] = $imageData;
         }
 
diff --git a/Plugin/AddWebpToSwatchesAjaxData.php b/Plugin/AddWebpToSwatchesAjaxData.php
@@ -48,6 +48,10 @@ public function afterGetProductMediaGallery(SwatchesDataHelper $subject, array $
             $images[$type . '_webp'] = $this->getWebpUrl($images[$type]);
         }
 
+        if (!isset($images['gallery'])) {
+            return $images;
+        }
+
         foreach ($images['gallery'] as $galleryIndex => $galleryImages) {
             foreach ($types as $type) {
                 if (!isset($images[$type])) {
diff --git a/Test/Integration/Common.php b/Test/Integration/Common.php
@@ -9,7 +9,7 @@
 use Magento\Framework\View\LayoutInterface;
 use Magento\TestFramework\TestCase\AbstractController;
 use RuntimeException;
-use Lof\Webp2\Image\ConvertWrapper;
+use Lof\Webp2\Convertor\ConvertWrapper;
 use Lof\Webp2\Test\Utils\ImageProvider;
 use Lof\Webp2\Test\Utils\ConvertWrapperStub;
 
@@ -70,8 +70,9 @@ protected function getImageProvider(): ImageProvider
 
     /**
      * @param string $body
+     * @param array $images
      */
-    protected function assertImageTagsExist(string $body, $images)
+    protected function assertImageTagsExist(string $body, array $images)
     {
         foreach ($images as $image) {
             $webPImage = preg_replace('/\.(png|jpg)$/', '.webp', $image);
diff --git a/Test/Unit/Config/ConfigTest.php b/Test/Unit/Config/ConfigTest.php
@@ -3,6 +3,7 @@
 namespace Lof\Webp2\Test\Unit\Config;
 
 use Magento\Framework\App\Config\ScopeConfigInterface;
+use Magento\Store\Model\StoreManagerInterface;
 use PHPUnit\Framework\TestCase;
 use Lof\Webp2\Config\Config;
 
@@ -11,7 +12,8 @@ class ConfigTest extends TestCase
     public function testEnabled()
     {
         $scopeConfig = $this->createMock(ScopeConfigInterface::class);
-        $config = new Config($scopeConfig);
+        $storeManager = $this->createMock(StoreManagerInterface::class);
+        $config = new Config($scopeConfig, $storeManager);
         $this->assertFalse($config->enabled());
 
         $scopeConfig->method('getValue')->willReturn(1);
@@ -21,29 +23,31 @@ public function testEnabled()
     public function testGetQualityLevel()
     {
         $scopeConfig = $this->createMock(ScopeConfigInterface::class);
-        $config = new Config($scopeConfig);
+        $storeManager = $this->createMock(StoreManagerInterface::class);
+        $config = new Config($scopeConfig, $storeManager);
         $this->assertEquals(1, $config->getQualityLevel());
 
         $scopeConfig = $this->createMock(ScopeConfigInterface::class);
-        $config = new Config($scopeConfig);
+        $config = new Config($scopeConfig, $storeManager);
         $scopeConfig->method('getValue')->willReturn(42);
         $this->assertEquals(42, $config->getQualityLevel());
 
         $scopeConfig = $this->createMock(ScopeConfigInterface::class);
-        $config = new Config($scopeConfig);
         $scopeConfig->method('getValue')->willReturn(142);
+        $config = new Config($scopeConfig, $storeManager);
         $this->assertEquals(100, $config->getQualityLevel());
 
         $scopeConfig = $this->createMock(ScopeConfigInterface::class);
-        $config = new Config($scopeConfig);
         $scopeConfig->method('getValue')->willReturn(0);
+        $config = new Config($scopeConfig, $storeManager);
         $this->assertEquals(1, $config->getQualityLevel());
     }
 
     public function testGetConvertors()
     {
         $scopeConfig = $this->createMock(ScopeConfigInterface::class);
-        $config = new Config($scopeConfig);
+        $storeManager = $this->createMock(StoreManagerInterface::class);
+        $config = new Config($scopeConfig, $storeManager);
         $this->assertNotEmpty($config->getConvertors());
     }
 }
diff --git a/Test/Unit/Convertor/ConvertorTest.php b/Test/Unit/Convertor/ConvertorTest.php
@@ -12,7 +12,7 @@
 use Lof\NextGenImages\Logger\Debugger;
 use Lof\Webp2\Config\Config;
 use Lof\Webp2\Convertor\Convertor;
-use Lof\Webp2\Image\ConvertWrapper;
+use Lof\Webp2\Convertor\ConvertWrapper;
 
 class ConvertorTest extends TestCase
 {
@@ -35,16 +35,8 @@ public function testGetSourceImage()
     public function testConvert()
     {
         $convertor = $this->getConvertor();
-        $this->assertFalse($convertor->convert('/images/test.jpg', '/images/test.webp'));
-    }
-
-    /**
-     * Test for Lof\Webp2\Convertor\Convertor::urlExists
-     */
-    public function testUrlExists()
-    {
-        $convertor = $this->getConvertor();
-        $this->assertFalse($convertor->urlExists('http://localhost/test.webp'));
+        $this->expectException(ConvertorException::class);
+        $convertor->convert('/images/test.jpg', '/images/test.webp');
     }
 
     /**
diff --git a/etc/adminhtml/system.xml b/etc/adminhtml/system.xml
diff --git a/etc/config.xml b/etc/config.xml
diff --git a/etc/frontend/di.xml b/etc/frontend/di.xml
diff --git a/view/frontend/web/js/has-webp.js b/view/frontend/web/js/has-webp.js
