[Versions] Detail Endpoint Improvements (#392)

* unify hydrator for asset versions * remove version test due to the core restrictions
pimcore · Aug 28, 2024 · 6f8d3d6 · 6f8d3d6
1 parent dbeaba7
commit 6f8d3d6
Show file tree

Hide file tree

Showing 9 changed files with 76 additions and 228 deletions.
diff --git a/src/Response/Schemas.php b/src/Response/Schemas.php
@@ -31,7 +31,6 @@
 use Pimcore\Bundle\StudioBackendBundle\Version\Schema\AssetVersion;
 use Pimcore\Bundle\StudioBackendBundle\Version\Schema\DataObjectVersion;
 use Pimcore\Bundle\StudioBackendBundle\Version\Schema\DocumentVersion;
-use Pimcore\Bundle\StudioBackendBundle\Version\Schema\ImageVersion;
 
 /**
  * @internal
@@ -56,7 +55,6 @@
 
     public const VERSIONS = [
         AssetVersion::class,
-        ImageVersion::class,
         DataObjectVersion::class,
         DocumentVersion::class,
     ];

diff --git a/src/Version/Event/ImageVersionEvent.php b/src/Version/Event/ImageVersionEvent.php
diff --git a/src/Version/Hydrator/AssetVersionHydrator.php b/src/Version/Hydrator/AssetVersionHydrator.php
@@ -20,12 +20,9 @@
 use Pimcore\Bundle\StudioBackendBundle\Asset\Service\DocumentServiceInterface;
 use Pimcore\Bundle\StudioBackendBundle\Util\Constant\Asset\MimeTypes;
 use Pimcore\Bundle\StudioBackendBundle\Version\Event\AssetVersionEvent;
-use Pimcore\Bundle\StudioBackendBundle\Version\Event\ImageVersionEvent;
 use Pimcore\Bundle\StudioBackendBundle\Version\Schema\AssetVersion;
-use Pimcore\Bundle\StudioBackendBundle\Version\Schema\ImageVersion;
 use Pimcore\Bundle\StudioBackendBundle\Version\Service\VersionDetailServiceInterface;
 use Pimcore\Model\Asset;
-use Pimcore\Model\Asset\Image;
 use Symfony\Component\EventDispatcher\EventDispatcherInterface;
 
 /**
@@ -46,7 +43,7 @@ public function __construct(
      */
     public function hydrate(
         Asset $asset
-    ): ImageVersion|AssetVersion {
+    ): AssetVersion {
         if (
             $asset instanceof Asset\Document &&
             $asset->getMimeType() === MimeTypes::PDF->value &&
@@ -57,12 +54,20 @@ public function hydrate(
             );
         }
 
-        if ($asset instanceof Image) {
-            return $this->hydrateImage($asset);
-        }
+        return $this->hydrateAsset($asset);
+    }
 
+    private function hydrateAsset(Asset $asset): AssetVersion
+    {
         $hydratedAsset = new AssetVersion(
-            fileName: $asset->getFilename()
+            $asset->getType(),
+            $asset->getFilename(),
+            $asset->getCreationDate(),
+            $asset->getModificationDate(),
+            $this->versionDetailService->getAssetFileSize($asset) ?? $asset->getFileSize(),
+            $asset->getMimeType(),
+            $this->customMetadataVersionHydrator->hydrate($asset->getMetadata()),
+            $this->versionDetailService->getDimensions($asset)
         );
 
         $this->eventDispatcher->dispatch(
@@ -72,24 +77,4 @@ public function hydrate(
 
         return $hydratedAsset;
     }
-
-    private function hydrateImage(Image $image): ImageVersion
-    {
-        $hydratedImage = new ImageVersion(
-            $image->getFilename(),
-            $image->getCreationDate(),
-            $image->getModificationDate(),
-            $this->versionDetailService->getAssetFileSize($image) ?? $image->getFileSize(),
-            $image->getMimeType(),
-            $this->customMetadataVersionHydrator->hydrate($image->getMetadata()),
-            $this->versionDetailService->getImageDimensions($image)
-        );
-
-        $this->eventDispatcher->dispatch(
-            new ImageVersionEvent($hydratedImage),
-            ImageVersionEvent::EVENT_NAME
-        );
-
-        return $hydratedImage;
-    }
 }
diff --git a/src/Version/Hydrator/AssetVersionHydratorInterface.php b/src/Version/Hydrator/AssetVersionHydratorInterface.php
@@ -17,7 +17,6 @@
 namespace Pimcore\Bundle\StudioBackendBundle\Version\Hydrator;
 
 use Pimcore\Bundle\StudioBackendBundle\Version\Schema\AssetVersion;
-use Pimcore\Bundle\StudioBackendBundle\Version\Schema\ImageVersion;
 use Pimcore\Model\Asset;
 
 /**
@@ -27,5 +26,5 @@ interface AssetVersionHydratorInterface
 {
     public function hydrate(
         Asset $asset
-    ): ImageVersion|AssetVersion;
+    ): AssetVersion;
 }
diff --git a/src/Version/Schema/AssetVersion.php b/src/Version/Schema/AssetVersion.php
@@ -16,28 +16,78 @@
 
 namespace Pimcore\Bundle\StudioBackendBundle\Version\Schema;
 
+use OpenApi\Attributes\Items;
 use OpenApi\Attributes\Property;
 use OpenApi\Attributes\Schema;
 use Pimcore\Bundle\StudioBackendBundle\Util\Schema\AdditionalAttributesInterface;
 use Pimcore\Bundle\StudioBackendBundle\Util\Trait\AdditionalAttributesTrait;
 
 #[Schema(
     title: 'AssetVersion',
-    required: ['fileName'],
+    required: ['type', 'fileName', 'creationDate', 'fileSize', 'mimeType', 'metadata', 'dimensions'],
     type: 'object'
 )]
-final class AssetVersion implements AdditionalAttributesInterface
+class AssetVersion implements AdditionalAttributesInterface
 {
     use AdditionalAttributesTrait;
 
     public function __construct(
+        #[Property(description: 'asset type', type: 'string', example: 'image')]
+        private readonly string $type,
         #[Property(description: 'file name', type: 'string', example: 'myImageFile.png')]
-        private readonly string $fileName
+        private readonly string $fileName,
+        #[Property(description: 'creation date', type: 'integer', example: 1707312457)]
+        private readonly int $creationDate,
+        #[Property(description: 'modification date', type: 'integer', example: 1707312457)]
+        private readonly ?int $modificationDate,
+        #[Property(description: 'file size', type: 'integer', example: 41862)]
+        private readonly int $fileSize,
+        #[Property(description: 'mime type', type: 'string', example: 'image/png')]
+        private readonly string $mimeType,
+        #[Property(description: 'Metadata', type: 'array', items: new Items(ref: CustomMetadataVersion::class))]
+        private readonly array $metadata,
+        #[Property(description: 'dimensions', type: Dimensions::class, example: '{"width":1920,"height":1080}')]
+        private readonly Dimensions $dimensions,
     ) {
     }
 
+    public function getType(): string
+    {
+        return $this->type;
+    }
+
     public function getFileName(): string
     {
         return $this->fileName;
     }
+
+    public function getCreationDate(): int
+    {
+        return $this->creationDate;
+    }
+
+    public function getModificationDate(): ?int
+    {
+        return $this->modificationDate;
+    }
+
+    public function getFileSize(): int
+    {
+        return $this->fileSize;
+    }
+
+    public function getMimeType(): string
+    {
+        return $this->mimeType;
+    }
+
+    public function getMetadata(): array
+    {
+        return $this->metadata;
+    }
+
+    public function getDimensions(): Dimensions
+    {
+        return $this->dimensions;
+    }
 }
diff --git a/src/Version/Schema/ImageVersion.php b/src/Version/Schema/ImageVersion.php
diff --git a/src/Version/Service/VersionDetailService.php b/src/Version/Service/VersionDetailService.php
@@ -26,9 +26,7 @@
 use Pimcore\Bundle\StudioBackendBundle\Version\Schema\DataObjectVersion;
 use Pimcore\Bundle\StudioBackendBundle\Version\Schema\Dimensions;
 use Pimcore\Bundle\StudioBackendBundle\Version\Schema\DocumentVersion;
-use Pimcore\Bundle\StudioBackendBundle\Version\Schema\ImageVersion;
 use Pimcore\Model\Asset;
-use Pimcore\Model\Asset\Image;
 use Pimcore\Model\Element\ElementInterface;
 use Pimcore\Model\UserInterface;
 use Symfony\Component\Finder\Exception\AccessDeniedException;
@@ -53,7 +51,7 @@ public function __construct(
     public function getVersionData(
         int $id,
         UserInterface $user
-    ): AssetVersion|ImageVersion|DataObjectVersion|DocumentVersion {
+    ): AssetVersion|DataObjectVersion|DocumentVersion {
         $version = $this->repository->getVersionById($id);
         $element = $this->repository->getElementFromVersion($version, $user);
 
@@ -69,9 +67,9 @@ public function getVersionData(
      *
      * @throws ElementStreamResourceNotFoundException
      */
-    public function getImageDimensions(Image $image): Dimensions
+    public function getDimensions(Asset $asset): Dimensions
     {
-        $path = $this->getLocalAssetPath($image);
+        $path = $this->getLocalAssetPath($asset);
 
         if (is_readable($path)) {
             $assetDimensions = getimagesize($path);
@@ -93,9 +91,9 @@ public function getImageDimensions(Image $image): Dimensions
      *
      * @throws ElementStreamResourceNotFoundException
      */
-    public function getAssetFileSize(Asset $image): ?int
+    public function getAssetFileSize(Asset $asset): ?int
     {
-        $path = $this->getLocalAssetPath($image);
+        $path = $this->getLocalAssetPath($asset);
 
         if (is_readable($path)) {
             return filesize($path);
@@ -125,7 +123,7 @@ private function getLocalAssetPath(Asset $asset): string
     private function hydrate(
         ElementInterface $element,
         string $class
-    ): AssetVersion|ImageVersion|DocumentVersion|DataObjectVersion {
+    ): AssetVersion|DocumentVersion|DataObjectVersion {
         if ($this->versionHydratorLocator->has($class)) {
             return $this->versionHydratorLocator->get($class)->hydrate($element);
         }

diff --git a/src/Version/Service/VersionDetailServiceInterface.php b/src/Version/Service/VersionDetailServiceInterface.php
@@ -23,9 +23,7 @@
 use Pimcore\Bundle\StudioBackendBundle\Version\Schema\DataObjectVersion;
 use Pimcore\Bundle\StudioBackendBundle\Version\Schema\Dimensions;
 use Pimcore\Bundle\StudioBackendBundle\Version\Schema\DocumentVersion;
-use Pimcore\Bundle\StudioBackendBundle\Version\Schema\ImageVersion;
 use Pimcore\Model\Asset;
-use Pimcore\Model\Asset\Image;
 use Pimcore\Model\UserInterface;
 use Symfony\Component\Finder\Exception\AccessDeniedException;
 
@@ -40,15 +38,15 @@ interface VersionDetailServiceInterface
     public function getVersionData(
         int $id,
         UserInterface $user
-    ): AssetVersion|ImageVersion|DataObjectVersion|DocumentVersion;
+    ): AssetVersion|DataObjectVersion|DocumentVersion;
 
     /**
      * @throws ElementStreamResourceNotFoundException
      */
-    public function getImageDimensions(Image $image): Dimensions;
+    public function getDimensions(Asset $asset): Dimensions;
 
     /**
      * @throws ElementStreamResourceNotFoundException
      */
-    public function getAssetFileSize(Asset $image): ?int;
+    public function getAssetFileSize(Asset $asset): ?int;
 }