[5.x] Pass original upload filename into AssetUploaded event (#11423)

Author: daun

src/Assets/Asset.php

@@ -930,7 +930,7 @@ public function upload(UploadedFile $file)
             ->syncOriginal()
             ->save();
 
-        AssetUploaded::dispatch($this);
+        AssetUploaded::dispatch($this, $file->getClientOriginalName());
 
         AssetCreated::dispatch($this);
 
@@ -948,7 +948,7 @@ public function reupload(ReplacementFile $file)
         $this->clearCaches();
         $this->writeMeta($this->generateMeta());
 
-        AssetReuploaded::dispatch($this);
+        AssetReuploaded::dispatch($this, $file->basename());
 
         return $this;
     }

src/Assets/ReplacementFile.php

@@ -24,6 +24,11 @@ public function extension()
         return pathinfo($this->path, PATHINFO_EXTENSION);
     }
 
+    public function basename()
+    {
+        return pathinfo($this->path, PATHINFO_BASENAME);
+    }
+
     public function writeTo(Filesystem $disk, $path)
     {
         $disk->put(

src/Events/AssetReuploaded.php

@@ -6,7 +6,7 @@
 
 class AssetReuploaded extends Event implements ProvidesCommitMessage
 {
-    public function __construct(public $asset)
+    public function __construct(public $asset, public $originalFilename)
     {
     }
 

src/Events/AssetUploaded.php

@@ -6,7 +6,7 @@
 
 class AssetUploaded extends Event implements ProvidesCommitMessage
 {
-    public function __construct(public $asset)
+    public function __construct(public $asset, public $originalFilename)
     {
     }
 

tests/Assets/AssetTest.php

@@ -2080,6 +2080,22 @@ public function it_appends_timestamp_to_uploaded_files_filename_if_it_already_ex
         });
     }
 
+    #[Test]
+    public function it_sanitizes_uploaded_filenames_but_passes_the_original_name_into_the_event()
+    {
+        Event::fake();
+        $asset = $this->container->makeAsset('path/to/Sanitize This Asset © Photographer.JPG');
+        Facades\AssetContainer::shouldReceive('findByHandle')->with('test_container')->andReturn($this->container);
+
+        $asset->upload(UploadedFile::fake()->image('Sanitize This Asset © Photographer.JPG'));
+
+        Storage::disk('test')->assertExists('path/to/sanitize-this-asset--photographer.jpg');
+        $this->assertEquals('path/to/sanitize-this-asset--photographer.jpg', $asset->path());
+        Event::assertDispatched(AssetUploaded::class, function ($event) use ($asset) {
+            return $event->asset = $asset && $event->originalFilename === 'Sanitize This Asset © Photographer.JPG';
+        });
+    }
+
     #[Test]
     public function it_lowercases_uploaded_filenames_by_default()
     {

tests/Assets/GeneratePresetImageManipulationsOnUpload.php

@@ -28,10 +28,10 @@ public function it_subscribes()
 
     #[Test]
     #[DataProvider('presetProvider')]
-    public function presets_are_generated_for_images($event, $extension, $shouldGenerate)
+    public function presets_are_generated_for_images($event, $basename, $shouldGenerate)
     {
         $generator = Mockery::mock(PresetGenerator::class);
-        $asset = (new Asset)->path('foo.'.$extension);
+        $asset = (new Asset)->path($basename);
 
         if ($shouldGenerate) {
             $generator->shouldReceive('generate')->once()->with($asset);
@@ -41,19 +41,19 @@ public function presets_are_generated_for_images($event, $extension, $shouldGene
 
         $listener = new GeneratePresetImageManipulations($generator);
 
-        $listener->handle(new $event($asset));
+        $listener->handle(new $event($asset, $basename));
     }
 
     public static function presetProvider()
     {
         return [
-            [AssetUploaded::class, 'jpg', true],
-            [AssetUploaded::class, 'svg', false],
-            [AssetUploaded::class, 'txt', false],
+            [AssetUploaded::class, 'foo.jpg', true],
+            [AssetUploaded::class, 'foo.svg', false],
+            [AssetUploaded::class, 'foo.txt', false],
 
-            [AssetReuploaded::class, 'jpg', true],
-            [AssetReuploaded::class, 'svg', false],
-            [AssetReuploaded::class, 'txt', false],
+            [AssetReuploaded::class, 'foo.jpg', true],
+            [AssetReuploaded::class, 'foo.svg', false],
+            [AssetReuploaded::class, 'foo.txt', false],
         ];
     }
 }

tests/Feature/Assets/ClearAssetGlideCacheTest.php

@@ -42,7 +42,7 @@ public function it_clears_when_reuploading()
         $asset = Mockery::mock(Asset::class);
         Glide::shouldReceive('clearAsset')->with($asset)->once();
 
-        app(ClearAssetGlideCache::class)->handleReuploaded(new AssetReuploaded($asset));
+        app(ClearAssetGlideCache::class)->handleReuploaded(new AssetReuploaded($asset, 'foo.jpg'));
     }
 
     #[Test]

tests/Feature/Assets/ReuploadAssetTest.php

@@ -75,6 +75,6 @@ public function glide_cache_is_cleared_and_presets_are_regenerated_when_reupload
         Glide::shouldReceive('clearAsset')->withArgs(fn ($arg1) => $arg1->id() === $asset->id())->once()->globally()->ordered();
         $this->mock(PresetGenerator::class)->shouldReceive('generate')->withArgs(fn ($arg1) => $arg1->id() === $asset->id())->once()->globally()->ordered();
 
-        AssetReuploaded::dispatch($asset);
+        AssetReuploaded::dispatch($asset, 'test.jpg');
     }
 }

tests/Git/GitEventTest.php

@@ -442,6 +442,7 @@ public function it_commits_when_asset_is_reuploaded()
 
         $file = Mockery::mock(ReplacementFile::class);
         $file->shouldReceive('extension')->andReturn('txt');
+        $file->shouldReceive('basename')->andReturn('file.txt');
         $file->shouldReceive('writeTo');
 
         $this->makeAsset()->reupload($file);