Refactor attachment cropping functionality to support multiple variants

- Introduced AttachmentCrop model to manage crop variants for attachments. - Updated Attachment model to remove direct crop fields and establish relationships with AttachmentCrop. - Modified AttachmentService to handle storing and updating multiple crop variants (desktop and mobile). - Adjusted validation rules to accommodate new crop structure. - Updated database migration to create attachment_crops table and migrate existing crop data. - Refactored tests to ensure compatibility with the new cropping structure and validate multiple crop variants. - Enhanced documentation to reflect changes in attachment handling and cropping capabilities.
2026-08-18 14:40:22 -03:00
parent c00b3d609c
commit e619c51ac9
14 changed files with 526 additions and 150 deletions
--- a/app/Domains/Attachable/Models/Attachment.php
+++ b/app/Domains/Attachable/Models/Attachment.php
@@ -6,7 +6,7 @@ use App\Domains\Attachable\Enums\AttachmentType;
 use Illuminate\Database\Eloquent\Attributes\Fillable;
 use Illuminate\Database\Eloquent\Factories\HasFactory;
 use Illuminate\Database\Eloquent\Model;
-use Illuminate\Database\Eloquent\Relations\BelongsTo;
+use Illuminate\Database\Eloquent\Relations\HasMany;
 use Illuminate\Database\Eloquent\Relations\HasOne;
 use Illuminate\Support\Facades\Storage;
 use Illuminate\Support\Str;
@@ -19,9 +19,6 @@ use Illuminate\Support\Str;
    'mime_type',
    'extension',
    'size',
-    'crop_horizontal',
-    'crop_vertical',
-    'cropped_attachment_id',
 ])]
 class Attachment extends Model
 {
@@ -43,20 +40,29 @@ class Attachment extends Model
        return [
            'type' => AttachmentType::class,
            'size' => 'integer',
-            'crop_horizontal' => 'array',
-            'crop_vertical' => 'array',
-            'cropped_attachment_id' => 'integer',
        ];
    }

-    public function croppedAttachment(): BelongsTo
+    public function cropVariants(): HasMany
    {
-        return $this->belongsTo(self::class, 'cropped_attachment_id');
+        return $this->hasMany(AttachmentCrop::class);
    }

-    public function originalAttachment(): HasOne
+    public function desktopCrop(): HasOne
    {
-        return $this->hasOne(self::class, 'cropped_attachment_id');
+        return $this->hasOne(AttachmentCrop::class)
+            ->where('variant', AttachmentCrop::DESKTOP);
+    }
+
+    public function mobileCrop(): HasOne
+    {
+        return $this->hasOne(AttachmentCrop::class)
+            ->where('variant', AttachmentCrop::MOBILE);
+    }
+
+    public function cropSource(): HasOne
+    {
+        return $this->hasOne(AttachmentCrop::class, 'cropped_attachment_id');
    }

    /**
--- a/app/Domains/Attachable/Models/AttachmentCrop.php
+++ b/app/Domains/Attachable/Models/AttachmentCrop.php
@@ -0,0 +1,43 @@
+<?php
+
+namespace App\Domains\Attachable\Models;
+
+use Illuminate\Database\Eloquent\Attributes\Fillable;
+use Illuminate\Database\Eloquent\Model;
+use Illuminate\Database\Eloquent\Relations\BelongsTo;
+
+#[Fillable([
+    'attachment_id',
+    'variant',
+    'crop_horizontal',
+    'crop_vertical',
+    'cropped_attachment_id',
+])]
+class AttachmentCrop extends Model
+{
+    public const DESKTOP = 'desktop';
+
+    public const MOBILE = 'mobile';
+
+    public const VARIANTS = [self::DESKTOP, self::MOBILE];
+
+    protected function casts(): array
+    {
+        return [
+            'attachment_id' => 'integer',
+            'crop_horizontal' => 'array',
+            'crop_vertical' => 'array',
+            'cropped_attachment_id' => 'integer',
+        ];
+    }
+
+    public function attachment(): BelongsTo
+    {
+        return $this->belongsTo(Attachment::class);
+    }
+
+    public function croppedAttachment(): BelongsTo
+    {
+        return $this->belongsTo(Attachment::class, 'cropped_attachment_id');
+    }
+}
--- a/app/Domains/Attachable/Services/AttachmentService.php
+++ b/app/Domains/Attachable/Services/AttachmentService.php
@@ -5,6 +5,7 @@ namespace App\Domains\Attachable\Services;
 use App\Domains\Attachable\Enums\AttachmentType;
 use App\Domains\Attachable\Exceptions\AttachmentStorageException;
 use App\Domains\Attachable\Models\Attachment;
+use App\Domains\Attachable\Models\AttachmentCrop;
 use Illuminate\Http\UploadedFile;
 use Illuminate\Support\Facades\DB;
 use Illuminate\Support\Facades\Storage;
@@ -14,46 +15,40 @@ use Throwable;

 class AttachmentService
 {
-    public function storeCroppedImage(
+    /**
+     * @param  array<string, array{crop_horizontal: array<string, mixed>, crop_vertical: array<string, mixed>}>  $crops
+     */
+    public function storeCroppedImageVariants(
        UploadedFile|string $image,
        string $path,
-        array $cropHorizontal,
-        array $cropVertical,
+        array $crops,
    ): Attachment {
-        $cropHorizontal = $this->validateCropRange($cropHorizontal, 'horizontal');
-        $cropVertical = $this->validateCropRange($cropVertical, 'vertical');
-
+        $crops = $this->validateCropVariants($crops);
        $storedPaths = [];

        try {
            return DB::transaction(function () use (
                $image,
                $path,
-                $cropHorizontal,
-                $cropVertical,
+                $crops,
                &$storedPaths,
            ): Attachment {
                $original = $this->store($image, $path);
                $storedPaths[] = $original->path;
+                $contents = $this->imageContents($image);

-                $croppedContents = $this->cropImage(
-                    $this->imageContents($image),
-                    $cropHorizontal,
-                    $cropVertical,
-                );
-                $cropped = $this->store(
-                    'data:'.$croppedContents['mime_type'].';base64,'.base64_encode($croppedContents['contents']),
-                    $path,
-                );
-                $storedPaths[] = $cropped->path;
+                foreach ($crops as $variant => $crop) {
+                    $cropped = $this->storeCropVariant($contents, $path, $crop);
+                    $storedPaths[] = $cropped->path;
+                    $original->cropVariants()->create([
+                        'variant' => $variant,
+                        'crop_horizontal' => $crop['crop_horizontal'],
+                        'crop_vertical' => $crop['crop_vertical'],
+                        'cropped_attachment_id' => $cropped->id,
+                    ]);
+                }

-                $original->update([
-                    'crop_horizontal' => $cropHorizontal,
-                    'crop_vertical' => $cropVertical,
-                    'cropped_attachment_id' => $cropped->id,
-                ]);
-
-                return $original->load('croppedAttachment');
+                return $original->load('cropVariants.croppedAttachment');
            });
        } catch (Throwable $throwable) {
            if ($storedPaths !== []) {
@@ -64,49 +59,61 @@ class AttachmentService
        }
    }

-    public function updateImageCrop(
+    /**
+     * @param  array<string, array{crop_horizontal: array<string, mixed>, crop_vertical: array<string, mixed>}>  $crops
+     */
+    public function updateImageCropVariants(
        Attachment $original,
-        array $cropHorizontal,
-        array $cropVertical,
+        array $crops,
    ): Attachment {
        if ($original->type !== AttachmentType::Image) {
            throw new AttachmentStorageException('Only image attachments can be cropped.');
        }

-        $cropHorizontal = $this->validateCropRange($cropHorizontal, 'horizontal');
-        $cropVertical = $this->validateCropRange($cropVertical, 'vertical');
+        $crops = $this->validateCropVariants($crops);
        $contents = Storage::disk('s3')->get($original->path);

        if (! is_string($contents) || $contents === '') {
            throw new AttachmentStorageException('The original image could not be read from the s3 disk.');
        }

-        $croppedContents = $this->cropImage($contents, $cropHorizontal, $cropVertical);
        $directory = trim(str_replace('\\', '/', dirname($original->path)), './');
        $directory = $directory !== '' ? $directory : 'attachments';
-        $previousCrop = $original->croppedAttachment;
-        $cropped = $this->store(
-            'data:'.$croppedContents['mime_type'].';base64,'.base64_encode($croppedContents['contents']),
-            $directory,
-        );
+        $previousCrops = $original->cropVariants()->with('croppedAttachment')->get();
+        $storedCrops = [];

        try {
-            $original->update([
-                'crop_horizontal' => $cropHorizontal,
-                'crop_vertical' => $cropVertical,
-                'cropped_attachment_id' => $cropped->id,
-            ]);
+            foreach ($crops as $variant => $crop) {
+                $storedCrops[$variant] = $this->storeCropVariant($contents, $directory, $crop);
+            }
+
+            DB::transaction(function () use ($original, $crops, $storedCrops): void {
+                foreach ($crops as $variant => $crop) {
+                    $original->cropVariants()->updateOrCreate(
+                        ['variant' => $variant],
+                        [
+                            'crop_horizontal' => $crop['crop_horizontal'],
+                            'crop_vertical' => $crop['crop_vertical'],
+                            'cropped_attachment_id' => $storedCrops[$variant]->id,
+                        ]
+                    );
+                }
+            });
        } catch (Throwable $throwable) {
-            $this->delete($cropped);
+            foreach ($storedCrops as $storedCrop) {
+                $this->delete($storedCrop);
+            }

            throw $throwable;
        }

-        if ($previousCrop !== null && ! $previousCrop->is($cropped)) {
-            $this->delete($previousCrop);
+        foreach ($previousCrops as $previousCrop) {
+            if ($previousCrop->croppedAttachment !== null) {
+                $this->delete($previousCrop->croppedAttachment);
+            }
        }

-        return $original->refresh()->load('croppedAttachment');
+        return $original->refresh()->load('cropVariants.croppedAttachment');
    }

    public function store(
@@ -153,11 +160,18 @@ class AttachmentService

    public function delete(Attachment $attachment): void
    {
-        $croppedAttachment = $attachment->croppedAttachment;
-        $paths = array_values(array_filter([
-            $attachment->path,
-            $croppedAttachment?->path,
-        ]));
+        $croppedAttachments = $attachment->cropVariants()
+            ->with('croppedAttachment')
+            ->get()
+            ->pluck('croppedAttachment')
+            ->filter();
+        $paths = $croppedAttachments
+            ->pluck('path')
+            ->prepend($attachment->path)
+            ->filter()
+            ->unique()
+            ->values()
+            ->all();
        $deleted = Storage::disk('s3')->delete(
            count($paths) === 1 ? $paths[0] : $paths
        );
@@ -166,9 +180,9 @@ class AttachmentService
            throw new AttachmentStorageException('No se pudieron eliminar los archivos del disco s3.');
        }

-        DB::transaction(function () use ($attachment, $croppedAttachment): void {
+        DB::transaction(function () use ($attachment, $croppedAttachments): void {
            $attachment->delete();
-            $croppedAttachment?->delete();
+            Attachment::query()->whereKey($croppedAttachments->pluck('id'))->delete();
        });
    }

@@ -213,6 +227,56 @@ class AttachmentService
        return trim($path, '/');
    }

+    /**
+     * @param  array<string, array{crop_horizontal?: mixed, crop_vertical?: mixed}>  $crops
+     * @return array<string, array{crop_horizontal: array{start_percentage: float, end_percentage: float}, crop_vertical: array{start_percentage: float, end_percentage: float}}>
+     */
+    protected function validateCropVariants(array $crops): array
+    {
+        $validated = [];
+
+        foreach (AttachmentCrop::VARIANTS as $variant) {
+            $crop = $crops[$variant] ?? null;
+
+            if (! is_array($crop)) {
+                throw new AttachmentStorageException("The {$variant} crop is required.");
+            }
+
+            $horizontal = $crop['crop_horizontal'] ?? null;
+            $vertical = $crop['crop_vertical'] ?? null;
+
+            if (! is_array($horizontal) || ! is_array($vertical)) {
+                throw new AttachmentStorageException(
+                    "The {$variant} crop must contain crop_horizontal and crop_vertical ranges."
+                );
+            }
+
+            $validated[$variant] = [
+                'crop_horizontal' => $this->validateCropRange($horizontal, "{$variant} horizontal"),
+                'crop_vertical' => $this->validateCropRange($vertical, "{$variant} vertical"),
+            ];
+        }
+
+        return $validated;
+    }
+
+    /**
+     * @param  array{crop_horizontal: array<string, mixed>, crop_vertical: array<string, mixed>}  $crop
+     */
+    protected function storeCropVariant(string $contents, string $path, array $crop): Attachment
+    {
+        $croppedContents = $this->cropImage(
+            $contents,
+            $crop['crop_horizontal'],
+            $crop['crop_vertical'],
+        );
+
+        return $this->store(
+            'data:'.$croppedContents['mime_type'].';base64,'.base64_encode($croppedContents['contents']),
+            $path,
+        );
+    }
+
    /**
     * @param  array{start_percentage?: mixed, end_percentage?: mixed}  $range
     * @return array{start_percentage: float, end_percentage: float}
--- a/app/Domains/Attachable/documentacion/README.md
+++ b/app/Domains/Attachable/documentacion/README.md
@@ -2,11 +2,12 @@

 ## Propósito

-Centraliza el almacenamiento y la metadata de archivos adjuntos. Acepta archivos subidos o contenido Base64, los persiste en S3 y registra su tipo, MIME, extensión, tamaño, nombre original y clave única. Para imágenes también permite guardar un original junto con una versión recortada desde porcentajes horizontales y verticales.
+Centraliza el almacenamiento y la metadata de archivos adjuntos. Acepta archivos subidos o contenido Base64, los persiste en S3 y registra su tipo, MIME, extensión, tamaño, nombre original y clave única. Para imágenes también permite guardar un original junto con variantes recortadas para desktop y mobile.

 ## Componentes principales

 - `Models/Attachment.php`: representa un adjunto y genera URL temporales de acceso.
+- `Models/AttachmentCrop.php`: relaciona un original con su crop desktop o mobile y la imagen generada.
 - `Services/AttachmentService.php`: almacena, copia y elimina archivos, compensando en S3 si falla la escritura en base de datos.
 - `Enums/AttachmentType.php`: clasifica imágenes, videos, PDF, audio, documentos y otros archivos.
 - `Exceptions/AttachmentStorageException.php`: expresa fallos propios del almacenamiento.
@@ -26,7 +27,7 @@ No expone rutas HTTP propias. Lo consumen otros dominios, especialmente `Catalog

 - El directorio no puede quedar vacío después de normalizarlo.
 - Cada eje del crop guarda `start_percentage` y `end_percentage`, cumpliendo `0 <= start < end <= 100`.
- El attachment original guarda los rangos horizontal y vertical y la relación `croppedAttachment` con la versión procesada.
- Al eliminar el original mediante el servicio también se elimina su versión recortada.
+- `attachment_crops` guarda una fila por variante con los rangos horizontal/vertical y el attachment procesado.
+- Al eliminar el original mediante el servicio también se eliminan todas sus variantes recortadas.
 - La eliminación se considera fallida si S3 no confirma el borrado.
 - Las URL generadas son temporales; el vencimiento predeterminado es de 10 minutos.
--- a/app/Domains/Shared/Rules/CroppedImageOrBase64Rule.php
+++ b/app/Domains/Shared/Rules/CroppedImageOrBase64Rule.php
@@ -35,6 +35,24 @@ class CroppedImageOrBase64Rule implements ValidationRule
            return;
        }

+        if (isset($value['crops']) && is_array($value['crops'])) {
+            foreach (['desktop', 'mobile'] as $variant) {
+                $crop = $value['crops'][$variant] ?? null;
+
+                if (! is_array($crop)) {
+                    $fail("The :attribute.crops.{$variant} field must be an object.");
+
+                    continue;
+                }
+
+                $this->validateRange("{$attribute}.crops.{$variant}", 'crop_horizontal', $crop, $fail);
+                $this->validateRange("{$attribute}.crops.{$variant}", 'crop_vertical', $crop, $fail);
+            }
+
+            return;
+        }
+
+        // Backwards compatibility with the original single-crop payload.
        $this->validateRange($attribute, 'crop_horizontal', $value, $fail);
        $this->validateRange($attribute, 'crop_vertical', $value, $fail);
    }
--- a/app/Domains/Tenant/Resources/AdminApp/WebsiteExtraResource.php
+++ b/app/Domains/Tenant/Resources/AdminApp/WebsiteExtraResource.php
@@ -3,6 +3,7 @@
 namespace App\Domains\Tenant\Resources\AdminApp;

 use App\Domains\Attachable\Models\Attachment;
+use App\Domains\Attachable\Models\AttachmentCrop;
 use App\Domains\Tenant\Models\WebsiteExtra;
 use Illuminate\Http\Request;
 use Illuminate\Http\Resources\Json\JsonResource;
@@ -49,10 +50,19 @@ class WebsiteExtraResource extends JsonResource

        $attachment = $config['background_image_id'];
        $fullRange = ['start_percentage' => 0.0, 'end_percentage' => 100.0];
+        $crops = $attachment->cropVariants->keyBy('variant');
        $config['background_image_id'] = [
            'url' => $attachment->getTemporaryUrl(1440),
-            'crop_horizontal' => $attachment->crop_horizontal ?? $fullRange,
-            'crop_vertical' => $attachment->crop_vertical ?? $fullRange,
+            'crops' => collect(AttachmentCrop::VARIANTS)->mapWithKeys(
+                function (string $variant) use ($crops, $fullRange): array {
+                    $crop = $crops->get($variant);
+
+                    return [$variant => [
+                        'crop_horizontal' => $crop?->crop_horizontal ?? $fullRange,
+                        'crop_vertical' => $crop?->crop_vertical ?? $fullRange,
+                    ]];
+                }
+            )->all(),
        ];

        return $config;
--- a/app/Domains/Tenant/Resources/AdminApp/WebsiteExtrasResource.php
+++ b/app/Domains/Tenant/Resources/AdminApp/WebsiteExtrasResource.php
@@ -3,6 +3,7 @@
 namespace App\Domains\Tenant\Resources\AdminApp;

 use App\Domains\Attachable\Models\Attachment;
+use App\Domains\Attachable\Models\AttachmentCrop;
 use App\Domains\Tenant\Models\Tenant;
 use Illuminate\Http\Request;
 use Illuminate\Http\Resources\Json\JsonResource;
@@ -70,16 +71,25 @@ class WebsiteExtrasResource extends JsonResource
    }

    /**
-     * @return array{url: string, crop_horizontal: array<string, float>, crop_vertical: array<string, float>}
+     * @return array{url: string, crops: array<string, array<string, array<string, float>>>}
     */
    private function formatHeroAttachment(Attachment $attachment): array
    {
        $fullRange = ['start_percentage' => 0.0, 'end_percentage' => 100.0];
+        $crops = $attachment->cropVariants->keyBy('variant');

        return [
            'url' => $attachment->getTemporaryUrl(1440),
-            'crop_horizontal' => $attachment->crop_horizontal ?? $fullRange,
-            'crop_vertical' => $attachment->crop_vertical ?? $fullRange,
+            'crops' => collect(AttachmentCrop::VARIANTS)->mapWithKeys(
+                function (string $variant) use ($crops, $fullRange): array {
+                    $crop = $crops->get($variant);
+
+                    return [$variant => [
+                        'crop_horizontal' => $crop?->crop_horizontal ?? $fullRange,
+                        'crop_vertical' => $crop?->crop_vertical ?? $fullRange,
+                    ]];
+                }
+            )->all(),
        ];
    }

--- a/app/Domains/Tenant/Resources/TenantResource.php
+++ b/app/Domains/Tenant/Resources/TenantResource.php
@@ -3,6 +3,7 @@
 namespace App\Domains\Tenant\Resources;

 use App\Domains\Attachable\Models\Attachment;
+use App\Domains\Attachable\Models\AttachmentCrop;
 use App\Domains\Catalog\Models\Category;
 use App\Domains\Menu\Models\Menu;
 use App\Domains\Tenant\Models\Tenant;
@@ -98,7 +99,18 @@ class TenantResource extends JsonResource
    private function formatExtraConfig(mixed $value): mixed
    {
        if ($value instanceof Attachment) {
-            return ($value->croppedAttachment ?? $value)->getTemporaryUrl(1440);
+            $crops = $value->cropVariants->keyBy('variant');
+            $desktop = $crops->get(AttachmentCrop::DESKTOP)?->croppedAttachment ?? $value;
+            $mobile = $crops->get(AttachmentCrop::MOBILE)?->croppedAttachment ?? $desktop;
+
+            if ($crops->isEmpty()) {
+                return $value->getTemporaryUrl(1440);
+            }
+
+            return [
+                'desktop' => $desktop->getTemporaryUrl(1440),
+                'mobile' => $mobile->getTemporaryUrl(1440),
+            ];
        }

        if (! is_array($value)) {
--- a/app/Domains/Tenant/Services/TenantInformationService.php
+++ b/app/Domains/Tenant/Services/TenantInformationService.php
@@ -81,7 +81,7 @@ class TenantInformationService

        $attachments = Attachment::query()
            ->whereIn('id', $attachmentIds)
-            ->with('croppedAttachment')
+            ->with('cropVariants.croppedAttachment')
            ->get()
            ->keyBy('id');

--- a/app/Domains/Tenant/Services/WebsiteExtraService.php
+++ b/app/Domains/Tenant/Services/WebsiteExtraService.php
@@ -334,8 +334,7 @@ class WebsiteExtraService
            );
        }

-        $cropHorizontal = is_array($value) ? $value['crop_horizontal'] ?? null : null;
-        $cropVertical = is_array($value) ? $value['crop_vertical'] ?? null : null;
+        $crops = $this->cropVariants($value);
        $image = is_array($value) ? $value['image'] ?? null : $value;

        if (is_string($image) && Str::isUuid($image)) {
@@ -349,19 +348,17 @@ class WebsiteExtraService
                ]);
            }

-            if (is_array($cropHorizontal) && is_array($cropVertical)) {
-                $attachment = $this->attachmentService->updateImageCrop(
+            if ($crops !== null) {
+                $attachment = $this->attachmentService->updateImageCropVariants(
                    $attachment,
-                    $cropHorizontal,
-                    $cropVertical,
+                    $crops,
                );
            }
-        } elseif (is_array($cropHorizontal) && is_array($cropVertical)) {
-            $attachment = $this->attachmentService->storeCroppedImage(
+        } elseif ($crops !== null) {
+            $attachment = $this->attachmentService->storeCroppedImageVariants(
                $image,
                "tenants/{$tenant->codigo}/extras/{$definition->codigo}",
-                $cropHorizontal,
-                $cropVertical,
+                $crops,
            );
        } else {
            $attachment = $this->attachmentService->store(
@@ -386,4 +383,37 @@ class WebsiteExtraService

        return $attachment->id;
    }
+
+    /**
+     * Normalize the current variants payload and the original single-crop contract.
+     *
+     * @return array<string, array<string, mixed>>|null
+     */
+    private function cropVariants(mixed $value): ?array
+    {
+        if (! is_array($value)) {
+            return null;
+        }
+
+        if (isset($value['crops']) && is_array($value['crops'])) {
+            return $value['crops'];
+        }
+
+        $horizontal = $value['crop_horizontal'] ?? null;
+        $vertical = $value['crop_vertical'] ?? null;
+
+        if (! is_array($horizontal) || ! is_array($vertical)) {
+            return null;
+        }
+
+        $crop = [
+            'crop_horizontal' => $horizontal,
+            'crop_vertical' => $vertical,
+        ];
+
+        return [
+            'desktop' => $crop,
+            'mobile' => $crop,
+        ];
+    }
 }