Fix media-library:clean command when using custom path generators

src/MediaCollections/Commands/CleanCommand.php

@@ -14,7 +14,7 @@
 use Spatie\MediaLibrary\MediaCollections\MediaRepository;
 use Spatie\MediaLibrary\MediaCollections\Models\Media;
 use Spatie\MediaLibrary\ResponsiveImages\RegisteredResponsiveImages;
-use Spatie\MediaLibrary\Support\PathGenerator\DefaultPathGenerator;
+use Spatie\MediaLibrary\Support\PathGenerator\PathGeneratorFactory;
 
 class CleanCommand extends Command
 {
@@ -34,8 +34,6 @@ class CleanCommand extends Command
 
     protected Factory $fileSystem;
 
-    protected DefaultPathGenerator $basePathGenerator;
-
     protected bool $isDryRun = false;
 
     protected int $rateLimit = 0;
@@ -44,12 +42,10 @@ public function handle(
         MediaRepository $mediaRepository,
         FileManipulator $fileManipulator,
         Factory $fileSystem,
-        DefaultPathGenerator $basePathGenerator
     ) {
         $this->mediaRepository = $mediaRepository;
         $this->fileManipulator = $fileManipulator;
         $this->fileSystem = $fileSystem;
-        $this->basePathGenerator = $basePathGenerator;
 
         if (! $this->confirmToProceed()) {
             return;
@@ -110,11 +106,12 @@ protected function deleteConversionFilesForDeprecatedConversions(Media $media):
     {
         $conversionFilePaths = ConversionCollection::createForMedia($media)->getConversionsFiles($media->collection_name);
 
-        $conversionPath = $this->basePathGenerator->getPathForConversions($media);
+        $conversionPath = PathGeneratorFactory::create($media)->getPathForConversions($media);
         $currentFilePaths = $this->fileSystem->disk($media->disk)->files($conversionPath);
 
         collect($currentFilePaths)
             ->reject(fn (string $currentFilePath) => $conversionFilePaths->contains(basename($currentFilePath)))
+            ->reject(fn (string $currentFilePath) => $media->file_name === basename($currentFilePath))
             ->each(function (string $currentFilePath) use ($media) {
                 if (! $this->isDryRun) {
                     $this->fileSystem->disk($media->disk)->delete($currentFilePath);

tests/Conversions/Commands/CleanConversionsTest.php

@@ -3,8 +3,11 @@
 use Illuminate\Support\Facades\DB;
 use Spatie\MediaLibrary\MediaCollections\Exceptions\DiskDoesNotExist;
 use Spatie\MediaLibrary\MediaCollections\Models\Media;
+use Spatie\MediaLibrary\Support\UrlGenerator\DefaultUrlGenerator;
+use Spatie\MediaLibrary\Tests\Support\PathGenerator\CustomPathGenerator;
 use Spatie\MediaLibrary\Tests\TestSupport\TestModels\TestModel;
 use Spatie\MediaLibrary\Tests\TestSupport\TestModels\TestModelWithConversion;
+use Spatie\MediaLibrary\Tests\TestSupport\TestPathGenerators\TestPathGeneratorConversionsInOriginalImageDirectory;
 
 beforeEach(function () {
     $this->media['model1']['collection1'] = $this->testModel
@@ -172,3 +175,62 @@
     $this->artisan('media-library:clean')
         ->assertExitCode(1);
 });
+
+it('can clean deprecated conversion files in custom path', function () {
+    $this->config = app('config');
+
+    $this->urlGenerator = new DefaultUrlGenerator($this->config);
+
+    $this->pathGenerator = new CustomPathGenerator();
+
+    $this->urlGenerator->setPathGenerator($this->pathGenerator);
+
+    config()->set('media-library.custom_path_generators', [
+        TestModelWithConversion::class => CustomPathGenerator::class,
+    ]);
+
+    $media = $this->testModelWithConversion
+        ->addMedia($this->getTestJpg())
+        ->preservingOriginal()
+        ->toMediaCollection();
+
+    $deprecatedImage = $this->getMediaDirectory(md5($media->id) . "/c/test-deprecated.jpg");
+
+    touch($deprecatedImage);
+    expect($deprecatedImage)->toBeFile();
+
+    $this->artisan('media-library:clean');
+
+    $this->assertFileDoesNotExist($deprecatedImage);
+    expect($this->getMediaDirectory(md5($media->id) . "/c/test-thumb.jpg"))->toBeFile();
+});
+
+it('can clean deprecated conversion files in same path as original image', function () {
+    $this->config = app('config');
+
+    $this->urlGenerator = new DefaultUrlGenerator($this->config);
+
+    $this->pathGenerator = new TestPathGeneratorConversionsInOriginalImageDirectory();
+
+    $this->urlGenerator->setPathGenerator($this->pathGenerator);
+
+    config()->set('media-library.custom_path_generators', [
+        TestModelWithConversion::class => TestPathGeneratorConversionsInOriginalImageDirectory::class,
+    ]);
+
+    $media = $this->testModelWithConversion
+        ->addMedia($this->getTestJpg())
+        ->preservingOriginal()
+        ->toMediaCollection();
+
+    $deprecatedImage = $this->getMediaDirectory("{$media->id}/test-deprecated.jpg");
+
+    touch($deprecatedImage);
+    expect($deprecatedImage)->toBeFile();
+
+    $this->artisan('media-library:clean');
+
+    $this->assertFileDoesNotExist($deprecatedImage);
+    expect($this->getMediaDirectory("{$media->id}/test-thumb.jpg"))->toBeFile();
+    expect($this->getMediaDirectory("{$media->id}/test.jpg"))->toBeFile();
+});

tests/TestSupport/TestPathGenerators/TestPathGeneratorConversionsInOriginalImageDirectory.php

@@ -0,0 +1,15 @@
+<?php
+
+namespace Spatie\MediaLibrary\Tests\TestSupport\TestPathGenerators;
+
+use Spatie\MediaLibrary\MediaCollections\Models\Media;
+use Spatie\MediaLibrary\Support\PathGenerator\DefaultPathGenerator;
+use Spatie\MediaLibrary\Support\PathGenerator\PathGenerator;
+
+class TestPathGeneratorConversionsInOriginalImageDirectory extends DefaultPathGenerator implements PathGenerator
+{
+    public function getPathForConversions(Media $media): string
+    {
+        return $this->getPath($media);
+    }
+}