Migrate legacy thumbnails (fixes #235)

src/LegacyThumbnailMigrationHelper.php → src/Dev/Tasks/LegacyThumbnailMigrationHelper.php

@@ -1,11 +1,12 @@
 <?php
 
-namespace SilverStripe\Assets;
+namespace SilverStripe\Assets\Dev\Tasks;
 
 use Psr\Log\LoggerInterface;
 use Psr\Log\NullLogger;
-use SilverStripe\Assets\FilenameParsing\LegacyFileIDHelper;
+use SilverStripe\Assets\File;
 use SilverStripe\Assets\Flysystem\FlysystemAssetStore;
+use SilverStripe\Assets\Folder;
 use SilverStripe\Core\Config\Configurable;
 use SilverStripe\Core\Environment;
 use SilverStripe\Core\Injector\Injectable;

tests/php/LegacyThumbnailMigrationHelperTest.php → tests/php/Dev/Tasks/LegacyThumbnailMigrationHelperTest.php

@@ -1,19 +1,18 @@
 <?php
 
-namespace SilverStripe\Assets\Tests;
+namespace SilverStripe\Assets\Tests\Dev\Tasks;
 
 use Silverstripe\Assets\Dev\TestAssetStore;
 use SilverStripe\Assets\File;
-use SilverStripe\Assets\FileMigrationHelper;
+use SilverStripe\Assets\FilenameParsing\FileIDHelperResolutionStrategy;
+use SilverStripe\Assets\FilenameParsing\LegacyFileIDHelper;
 use SilverStripe\Assets\FilenameParsing\ParsedFileID;
 use SilverStripe\Assets\Filesystem;
-use SilverStripe\Assets\Flysystem\FlysystemAssetStore;
 use SilverStripe\Assets\Folder;
 use SilverStripe\Assets\Image;
-use SilverStripe\Assets\LegacyThumbnailMigrationHelper;
+use SilverStripe\Assets\Dev\Tasks\LegacyThumbnailMigrationHelper;
 use SilverStripe\Assets\Storage\AssetStore;
-use SilverStripe\Assets\Tests\FileMigrationHelperTest\Extension;
-use SilverStripe\Core\Config\Config;
+use SilverStripe\Assets\Tests\Dev\Tasks\FileMigrationHelperTest\Extension;
 use SilverStripe\Core\Convert;
 use SilverStripe\Dev\SapphireTest;
 
@@ -49,7 +48,7 @@ public function setUp()
         TestAssetStore::activate('LegacyThumbnailMigrationHelperTest/assets');
 
         // Ensure that each file has a local record file in this new assets base
-        $from = $this->joinPaths(__DIR__, 'ImageTest/test-image-low-quality.jpg');
+        $from = $this->joinPaths(__DIR__, '../../ImageTest/test-image-low-quality.jpg');
         foreach (File::get()->exclude('ClassName', Folder::class) as $file) {
             /** @var $file File */
             $file->setFromLocalFile($from, $file->generateFilename());
@@ -68,21 +67,48 @@ public function tearDown()
         parent::tearDown();
     }
 
+    /**
+     * Tests cases where files have already been migrated to 4.3 or older,
+     * and some images have since been unpublished or otherwise marked protected.
+     * The previously orphaned thumbnails wouldn't have been moved to the protected store in this case.
+     * The migration task should find those orphans, and reunite them with the original image.
+     * And they lived happily ever after.
+     */
     public function testMigratesThumbnailsForProtectedFiles()
     {
         /** @var TestAssetStore $store */
         $store = singleton(AssetStore::class); // will use TestAssetStore
 
+        // Remove the legacy helper, otherwise it'll move the _resampled files as well,
+        // which "pollutes" our test case.
+        /** @var FileIDHelperResolutionStrategy $strategy */
+        $publicStrategy = $store->getPublicResolutionStrategy();
+        $helpers = $publicStrategy->getResolutionFileIDHelpers();
+        $origHelpers = [];
+        foreach ($helpers as $i => $helper) {
+            $origHelpers[] = clone $helper;
+            if ($helper instanceof LegacyFileIDHelper) {
+                unset($helpers[$i]);
+            }
+        }
+        $publicStrategy->setResolutionFileIDHelpers($helpers);
+        $store->setPublicResolutionStrategy($publicStrategy);
+
         /** @var Image $image */
         $image = $this->objFromFixture(Image::class, 'nested');
 
         $formats = ['ResizedImage' => [60,60]];
         $expectedLegacyPath = $this->createLegacyResampledImageFixture($store, $image, $formats);
 
-        // Protect file *after* creating legacy fixture
+        // Protect file *after* creating legacy fixture,
+        // but without moving the _resampled "orphan"
         $image->protectFile();
         $image->write();
 
+        // We need to retain the legacy helper for later assertions.
+        $publicStrategy->setResolutionFileIDHelpers($origHelpers);
+        $store->setPublicResolutionStrategy($publicStrategy);
+
         $helper = new LegacyThumbnailMigrationHelper();
         $moved = $helper->run($store);
 
@@ -100,7 +126,10 @@ public function testMigratesThumbnailsForProtectedFiles()
                 new ParsedFileID($image->Filename, $image->Hash),
                 $store->getProtectedFilesystem()
             );
-        $this->assertCount(1, $protectedVariants);
+
+        // findVariants() returns *both* the original file and the variant
+        // See FileIDHelperResolutionStrategyTest->testFindVariant()
+        $this->assertCount(2, $protectedVariants);
     }
 
     public function testMigratesWithExistingThumbnailInNewLocation()