feature: allow passing media timestamp to image service (#132)

xyng · tinect · web-flow · commit 39944f1fb18a · 2024-06-06T21:21:40.000+02:00
* feature: allow passing media timestamp to image service

* feat: change string "null" to "0"

* chore: release 5.1.0

---------

Co-authored-by: tinect &lt;s.koenig@tinect.de&gt;
diff --git a/.github/workflows/test.yml b/.github/workflows/test.yml
@@ -32,7 +32,6 @@ jobs:
           mysql -V
           php -v
           composer -V
-          echo ${{ github.workspace }}
 
       - name: Checkout
         uses: actions/checkout@v3
@@ -73,14 +72,14 @@ jobs:
         with:
           shopware-version: ${{ matrix.version }}
           php-version: ${{ matrix.php-version }}
+          php-extensions: pcov
 
       - name: Info
         run: |
           php bin/console -V
           mysql -V
           php -v
           composer -V
-          echo ${{ github.workspace }}
 
       - name: Checkout
         uses: actions/checkout@v3
diff --git a/CHANGELOG_en-GB.md b/CHANGELOG_en-GB.md
@@ -1,3 +1,6 @@
+# 5.1.0
+* Add variable mediaUpdatedAt for paths to prevent caching
+
 # 5.0.1
 * Fix support for cloning product entity
 
diff --git a/README.md b/README.md
@@ -48,6 +48,7 @@ Available variables with examples:
 * {mediaUrl}: https://www.example.com/
 * {mediaPath}: media/01/82/69/sasse.png
 * {width}: 800
+* {mediaUpdatedAt}: 1716882050 (unix timestamp) or 0
 
 Feel free to decorate `ThumbnailUrlTemplateInterface` to add more individual functions like [signed imgproxy](https://github.com/FriendsOfShopware/FroshPlatformThumbnailProcessorImgProxy)
 
diff --git a/composer.json b/composer.json
@@ -11,7 +11,7 @@
         "thumbnail"
     ],
     "description": "This plugins allows you to use variable thumbnails, without having them on storage.",
-    "version": "5.0.1",
+    "version": "5.1.0",
     "type": "shopware-platform-plugin",
     "license": "mit",
     "authors": [
diff --git a/src/Core/Media/MediaUrlGenerator.php b/src/Core/Media/MediaUrlGenerator.php
@@ -51,7 +51,8 @@ public function generate(array $paths): array
             $urls[$key] = $this->thumbnailUrlTemplate->getUrl(
                 $baseUrl,
                 $value->path,
-                $this->getWidth($maxWidth, $value)
+                $this->getWidth($maxWidth, $value),
+                $value->updatedAt
             );
         }
 
diff --git a/src/Resources/app/administration/src/module/frosh-thumbnail-processor/frosh-thumbnail-processor-info-texts/frosh-thumbnail-processor-info-texts.html.twig b/src/Resources/app/administration/src/module/frosh-thumbnail-processor/frosh-thumbnail-processor-info-texts/frosh-thumbnail-processor-info-texts.html.twig
@@ -9,6 +9,7 @@
             <b>{mediaUrl}</b>: e.g. https://cdn.test.de/<br>
             <b>{mediaPath}</b>: e.g. media/image/5b/6d/16/tea.png<br>
             <b>{width}</b>: e.g. 800
+            <b>{mediaUpdatedAt}</b>: 1716882050 (unix timestamp) or 0
         </p>
 
         <p>
diff --git a/src/Resources/config/config.xml b/src/Resources/config/config.xml
@@ -20,7 +20,8 @@
             <helpText><![CDATA[available variables:<br>
                 {mediaUrl}: https://cdn.test.de/<br>
                 {mediaPath}: media/image/5b/6d/16/tea.png<br>
-                {width}: 800
+                {width}: 800<br>
+                {mediaUpdatedAt}: 1716882050 (unix timestamp) or 0
             ]]></helpText>
         </input-field>
 
diff --git a/src/Service/ThumbnailUrlTemplate.php b/src/Service/ThumbnailUrlTemplate.php
@@ -11,11 +11,11 @@ public function __construct(
     ) {
     }
 
-    public function getUrl(string $mediaUrl, string $mediaPath, string $width): string
+    public function getUrl(string $mediaUrl, string $mediaPath, string $width, ?\DateTimeInterface $mediaUpdatedAt): string
     {
         return str_replace(
-            ['{mediaUrl}', '{mediaPath}', '{width}'],
-            [$mediaUrl, $mediaPath, $width],
+            ['{mediaUrl}', '{mediaPath}', '{width}', '{mediaUpdatedAt}'],
+            [$mediaUrl, $mediaPath, $width, $mediaUpdatedAt?->getTimestamp() ?: '0'],
             $this->getPattern()
         );
     }
diff --git a/src/Service/ThumbnailUrlTemplateInterface.php b/src/Service/ThumbnailUrlTemplateInterface.php
@@ -4,5 +4,5 @@
 
 interface ThumbnailUrlTemplateInterface
 {
-    public function getUrl(string $mediaUrl, string $mediaPath, string $width): string;
+    public function getUrl(string $mediaUrl, string $mediaPath, string $width, ?\DateTimeInterface $mediaUpdatedAt): string;
 }
diff --git a/tests/unit/Service/ThumbnailUrlTemplateTest.php b/tests/unit/Service/ThumbnailUrlTemplateTest.php
@@ -1,6 +1,6 @@
 <?php declare(strict_types=1);
 
-namespace Frosh\ThumbnailProcessor\TestsUnit\Service;
+namespace Frosh\ThumbnailProcessor\Tests\Unit\Service;
 
 use Frosh\ThumbnailProcessor\Service\ConfigReader;
 use Frosh\ThumbnailProcessor\Service\ThumbnailUrlTemplate;
@@ -9,65 +9,66 @@
 
 class ThumbnailUrlTemplateTest extends TestCase
 {
-    /**
+	/**
      * @dataProvider getSalesChannelIds
      */
-    public function testGetUrl(?string $salesChannelId, string $mediaUrl, string $mediaPath, string $width): void
+    public function testGetUrl(?string $salesChannelId, string $mediaUrl, string $mediaPath, string $width, ?\DateTimeInterface $date): void
     {
         $configReader = $this->createMock(ConfigReader::class);
         $configReader->expects(static::once())
-            ->method('getConfig')->willReturn('{mediaUrl}/{mediaPath}?width={width}&uff');
+            ->method('getConfig')->willReturn('{mediaUrl}/{mediaPath}?width={width}&updatedAt={mediaUpdatedAt}&uff');
 
         $class = new ThumbnailUrlTemplate($configReader);
 
-        $url = $class->getUrl($mediaUrl, $mediaPath, $width);
+        $url = $class->getUrl($mediaUrl, $mediaPath, $width, $date);
 
-        static::assertSame(\sprintf('%s/%s?width=%s&uff', $mediaUrl, $mediaPath, $width), $url);
+        static::assertSame(\sprintf('%s/%s?width=%s&updatedAt=%s&uff', $mediaUrl, $mediaPath, $width, $date?->getTimestamp() ?: '0'), $url);
     }
 
     /**
      * @dataProvider getSalesChannelIds
      */
-    public function testGetUrlWithoutSetConfig(?string $salesChannelId, string $mediaUrl, string $mediaPath, string $width): void
+    public function testGetUrlWithoutSetConfig(?string $salesChannelId, string $mediaUrl, string $mediaPath, string $width, ?\DateTimeInterface $date): void
     {
         $configReader = $this->createMock(ConfigReader::class);
         $configReader->expects(static::once())
-            ->method('getConfig')->willReturn('{mediaUrl}/{mediaPath}?width={width}');
+            ->method('getConfig')->willReturn('{mediaUrl}/{mediaPath}?width={width}&updatedAt={mediaUpdatedAt}');
 
         $class = new ThumbnailUrlTemplate($configReader);
 
-        $url = $class->getUrl($mediaUrl, $mediaPath, $width);
+        $url = $class->getUrl($mediaUrl, $mediaPath, $width, $date);
 
-        static::assertSame(\sprintf('%s/%s?width=%s', $mediaUrl, $mediaPath, $width), $url);
+        static::assertSame(\sprintf('%s/%s?width=%s&updatedAt=%s', $mediaUrl, $mediaPath, $width, $date?->getTimestamp() ?: '0'), $url);
     }
 
     /**
      * @dataProvider getSalesChannelIds
      */
-    public function testGetUrlGetPatternOnce(?string $salesChannelId, string $mediaUrl, string $mediaPath, string $width): void
+    public function testGetUrlGetPatternOnce(?string $salesChannelId, string $mediaUrl, string $mediaPath, string $width, ?\DateTimeInterface $date): void
     {
         $configReader = $this->createMock(ConfigReader::class);
         $configReader->expects(static::once())
-            ->method('getConfig')->willReturn('{mediaUrl}/{mediaPath}?width={width}');
+            ->method('getConfig')->willReturn('{mediaUrl}/{mediaPath}?width={width}&updatedAt={mediaUpdatedAt}');
 
         $class = new ThumbnailUrlTemplate($configReader);
 
-        $class->getUrl($mediaUrl, $mediaPath, $width);
+        $class->getUrl($mediaUrl, $mediaPath, $width, $date);
 
-        $url = $class->getUrl($mediaUrl, $mediaPath, $width);
+        $url = $class->getUrl($mediaUrl, $mediaPath, $width, $date);
 
-        static::assertSame(\sprintf('%s/%s?width=%s', $mediaUrl, $mediaPath, $width), $url);
+        static::assertSame(\sprintf('%s/%s?width=%s&updatedAt=%s', $mediaUrl, $mediaPath, $width, $date?->getTimestamp() ?: '0'), $url);
     }
 
     /**
      * @return iterable<array{string|null, string, string, string}>
      */
     public static function getSalesChannelIds(): iterable
     {
-        yield [null, 'https://www.anywebpage.test', 'media/78/a1/myimage.jpg', '200'];
-        yield [Uuid::randomHex(), 'https://www.anyotherwebpage.test', 'media/aa/a1/myimage.jpg', '300'];
-        yield [Uuid::randomHex(), 'https://www.anyother2webpage.test', 'media/aa/bb/myimage.jpg', '700'];
-        yield [Uuid::randomHex(), 'https://www.anyother3webpage.test', 'media/aa/cc/myimage.jpg', '900'];
-        yield [Uuid::randomHex(), 'https://www.anyother4webpage.test', 'media/aa/dd/myimage.jpg', '1000'];
+        yield [null, 'https://www.anywebpage.test', 'media/78/a1/myimage.jpg', '200', null];
+        yield [null, 'https://www.anyotherwebpage.test', 'media/78/a1/myimage.jpg', '200', new \DateTimeImmutable()];
+        yield [Uuid::randomHex(), 'https://www.anyother2webpage.test', 'media/aa/a1/myimage.jpg', '300', new \DateTimeImmutable()];
+        yield [Uuid::randomHex(), 'https://www.anyother3webpage.test', 'media/aa/bb/myimage.jpg', '700', null];
+        yield [Uuid::randomHex(), 'https://www.anyother4webpage.test', 'media/aa/cc/myimage.jpg', '900', new \DateTimeImmutable()];
+        yield [Uuid::randomHex(), 'https://www.anyother5webpage.test', 'media/aa/dd/myimage.jpg', '1000', null];
     }
 }

-Original file line number
+Diff line change
@@ @@ -1,3 +1,6 @@ @@
 +# 5.1.0
 +* Add variable mediaUpdatedAt for paths to prevent caching
++
 # 5.0.1
 * Fix support for cloning product entity
Original file line number	Diff line number	Diff line change
`@@ -51,7 +51,8 @@ public function generate(array $paths): array`
`51`	`51`	`$urls[$key] = $this->thumbnailUrlTemplate->getUrl(`
`52`	`52`	`$baseUrl,`
`53`	`53`	`$value->path,`
`54`		`- $this->getWidth($maxWidth, $value)`
	`54`	`+ $this->getWidth($maxWidth, $value),`
	`55`	`+ $value->updatedAt`
`55`	`56`	`);`
`56`	`57`	`}`
`57`	`58`
Original file line number	Diff line number	Diff line change
`@@ -11,11 +11,11 @@ public function __construct(`
`11`	`11`	`) {`
`12`	`12`	`}`
`13`	`13`
`14`		`- public function getUrl(string $mediaUrl, string $mediaPath, string $width): string`
	`14`	`+ public function getUrl(string $mediaUrl, string $mediaPath, string $width, ?\DateTimeInterface $mediaUpdatedAt): string`
`15`	`15`	`{`
`16`	`16`	`return str_replace(`
`17`		`- ['{mediaUrl}', '{mediaPath}', '{width}'],`
`18`		`- [$mediaUrl, $mediaPath, $width],`
	`17`	`+ ['{mediaUrl}', '{mediaPath}', '{width}', '{mediaUpdatedAt}'],`
	`18`	`+ [$mediaUrl, $mediaPath, $width, $mediaUpdatedAt?->getTimestamp() ?: '0'],`
`19`	`19`	`$this->getPattern()`
`20`	`20`	`);`
`21`	`21`	`}`
Original file line number	Diff line number	Diff line change
`@@ -4,5 +4,5 @@`
`4`	`4`
`5`	`5`	`interface ThumbnailUrlTemplateInterface`
`6`	`6`	`{`
`7`		`- public function getUrl(string $mediaUrl, string $mediaPath, string $width): string;`
	`7`	`+ public function getUrl(string $mediaUrl, string $mediaPath, string $width, ?\DateTimeInterface $mediaUpdatedAt): string;`
`8`	`8`	`}`