Add support for preview image in media serializer (#80)

sulu · Mar 26, 2021 · 76da5e9 · 76da5e9
1 parent cf92090
commit 76da5e9
Show file tree

Hide file tree

Showing 2 changed files with 78 additions and 5 deletions.
diff --git a/Content/Serializer/MediaSerializer.php b/Content/Serializer/MediaSerializer.php
@@ -80,21 +80,28 @@ public function serialize(MediaInterface $media, string $locale, ?SerializationC
         unset($mediaData['adminUrl']);
         unset($mediaData['_hash']);
 
+        $formatMediaApi = $apiMedia;
+        /** @var MediaInterface|null $previewImage */
+        $previewImage = $media->getPreviewImage();
+        if ($previewImage) {
+            $formatMediaApi = new Media($previewImage, $locale);
+        }
+
         /** @var string $fileName */
-        $fileName = $apiMedia->getName();
+        $fileName = $formatMediaApi->getName();
 
         // replace extension of filename with preferred media extension if possible
-        $preferredExtension = $this->imageConverter->getSupportedOutputImageFormats($apiMedia->getMimeType())[0] ?? null;
+        $preferredExtension = $this->imageConverter->getSupportedOutputImageFormats($formatMediaApi->getMimeType())[0] ?? null;
         if ($preferredExtension) {
             $fileName = pathinfo($fileName)['filename'] . '.' . $preferredExtension;
         }
 
         $mediaData['formatUri'] = $this->formatCache->getMediaUrl(
-            $apiMedia->getId(),
+            $formatMediaApi->getId(),
             $fileName,
             '{format}',
-            $apiMedia->getVersion(),
-            $apiMedia->getSubVersion()
+            $formatMediaApi->getVersion(),
+            $formatMediaApi->getSubVersion()
         );
 
         $this->referenceStore->add($apiMedia->getId());

diff --git a/Tests/Unit/Content/Serializer/MediaSerializerTest.php b/Tests/Unit/Content/Serializer/MediaSerializerTest.php
@@ -20,6 +20,8 @@
 use Sulu\Bundle\HeadlessBundle\Content\Serializer\MediaSerializer;
 use Sulu\Bundle\HeadlessBundle\Content\Serializer\MediaSerializerInterface;
 use Sulu\Bundle\MediaBundle\Api\Media;
+use Sulu\Bundle\MediaBundle\Entity\File;
+use Sulu\Bundle\MediaBundle\Entity\FileVersion;
 use Sulu\Bundle\MediaBundle\Entity\MediaInterface;
 use Sulu\Bundle\MediaBundle\Media\FormatCache\FormatCacheInterface;
 use Sulu\Bundle\MediaBundle\Media\ImageConverter\ImageConverterInterface;
@@ -128,6 +130,70 @@ public function testSerialize(): void
         ], $result);
     }
 
+    public function testSerializeWithPreviewImage(): void
+    {
+        $locale = 'en';
+        $media = $this->prophesize(MediaInterface::class);
+
+        // expected and unexpected object calls
+        $apiMedia = $this->prophesize(Media::class);
+        $apiMedia->getId()->willReturn(1)->shouldBeCalled();
+
+        $previewMediaFileVersion = $this->prophesize(FileVersion::class);
+        $previewMediaFileVersion->getName()->willReturn('preview-media.png')->shouldBeCalled();
+        $previewMediaFileVersion->getMimeType()->willReturn('image/png')->shouldBeCalled();
+        $previewMediaFileVersion->getVersion()->willReturn(1)->shouldBeCalled();
+        $previewMediaFileVersion->getSubVersion()->willReturn(0)->shouldBeCalled();
+
+        $previewMediaFile = $this->prophesize(File::class);
+        $previewMediaFile->getVersion()->willReturn(1)->shouldBeCalled();
+        $previewMediaFile->getFileVersion(1)->willReturn($previewMediaFileVersion->reveal())->shouldBeCalled();
+
+        $previewMedia = $this->prophesize(MediaInterface::class);
+        $previewMedia->getFiles()->willReturn([$previewMediaFile->reveal()])->shouldBeCalled();
+
+        $previewMedia->getId()->willReturn(1)->shouldBeCalled();
+        $media->getPreviewImage()->willReturn($previewMedia->reveal())->shouldBeCalled();
+
+        $apiMediaArgument = Argument::that(function (Media $apiMedia) use ($media, $locale) {
+            return $apiMedia->getEntity() === $media->reveal() && $locale === $apiMedia->getLocale();
+        });
+
+        // expected and unexpected service calls
+        $this->mediaManager->addFormatsAndUrl($apiMediaArgument)
+            ->willReturn($apiMedia->reveal())
+            ->shouldBeCalled();
+
+        $this->arraySerializer->serialize($apiMedia->reveal(), null)->willReturn([
+            'id' => 1,
+            'formats' => [],
+            'storageOptions' => [],
+            'thumbnails' => [],
+            'versions' => [],
+            'downloadCounter' => [],
+            '_hash' => [],
+        ])->shouldBeCalled();
+
+        $this->imageConverter->getSupportedOutputImageFormats('image/png')
+            ->willReturn([])
+            ->shouldBeCalled();
+
+        $this->formatCache->getMediaUrl(1, 'preview-media.png', '{format}', 1, 0)
+            ->willReturn('/media/1/{format}/preview-media.png?v=1-0')
+            ->shouldBeCalled();
+
+        $this->referenceStore->add(1)
+            ->shouldBeCalled();
+
+        // call test function
+        $result = $this->mediaSerializer->serialize($media->reveal(), $locale);
+
+        $this->assertSame([
+            'id' => 1,
+            'formatUri' => '/media/1/{format}/preview-media.png?v=1-0',
+        ], $result);
+    }
+
     public function testSerializeWithContext(): void
     {
         $locale = 'en';