Add pre-computation of thumb images for improved speed. (#3905)

Author: ildyria

.github/workflows/php_tests.yml

@@ -32,6 +32,7 @@ jobs:
           - Install
           - Webshop
           - ImageProcessing
+          - Precomputing
         exclude:
         # Some skips to reduce the number of runs
           - php-version: 8.4
@@ -42,6 +43,8 @@ jobs:
             test-suite: Webshop
           - php-version: 8.4
             test-suite: ImageProcessing
+          - php-version: 8.4
+            test-suite: Precomputing
     # Service containers to run with `container-job`
     services:
       # Label used to access the service container

Makefile

@@ -151,6 +151,9 @@ test_install:
 test_ImageProcessing:
 	vendor/bin/phpunit --testsuite ImageProcessing --stop-on-failure --stop-on-error --no-coverage --log-junit report_imageprocessing.xml
 
+test_precomputing:
+	vendor/bin/phpunit --testsuite Precomputing --stop-on-failure --stop-on-error --no-coverage --log-junit report_precomputing.xml
+
 test_v2:
 	vendor/bin/phpunit --testsuite Feature_v2 --stop-on-failure --stop-on-error --no-coverage --log-junit report_v2.xml
 

app/Actions/Album/Create.php

@@ -10,6 +10,7 @@
 
 use App\Constants\AccessPermissionConstants as APC;
 use App\Enum\DefaultAlbumProtectionType;
+use App\Events\AlbumSaved;
 use App\Exceptions\ConfigurationKeyMissingException;
 use App\Exceptions\ModelDBException;
 use App\Exceptions\UnauthenticatedException;
@@ -43,6 +44,9 @@ public function create(string $title, ?Album $parent_album): Album
 		$this->set_permissions($album, $parent_album);
 		$this->setStatistics($album);
 
+		// Dispatch event for album stats recomputation
+		AlbumSaved::dispatch($album);
+
 		return $album;
 	}
 

app/Actions/Album/Delete.php

@@ -14,6 +14,7 @@
 use App\Contracts\Exceptions\InternalLycheeException;
 use App\Enum\SmartAlbumType;
 use App\Enum\StorageDiskType;
+use App\Events\AlbumDeleted;
 use App\Exceptions\Internal\LycheeAssertionError;
 use App\Exceptions\Internal\QueryBuilderException;
 use App\Exceptions\ModelDBException;
@@ -90,6 +91,9 @@ public function do(array $album_ids): FileDeleter
 				->select(['id', 'parent_id', '_lft', '_rgt', 'track_short_path'])
 				->findMany($album_ids);
 
+			// Collect unique parent IDs BEFORE deletion for event dispatching
+			$parent_ids = $albums->pluck('parent_id')->filter()->unique()->values()->all();
+
 			$recursive_album_ids = $albums->pluck('id')->all(); // only IDs which refer to regular albums are incubators for recursive IDs
 			$recursive_album_tracks = $albums->pluck('track_short_path');
 
@@ -146,6 +150,11 @@ public function do(array $album_ids): FileDeleter
 				->whereNotIn(APC::ACCESS_PERMISSIONS . '.' . APC::BASE_ALBUM_ID, SmartAlbumType::values())
 				->delete();
 
+			// Dispatch events for parent albums to trigger recomputation
+			foreach ($parent_ids as $parent_id) {
+				AlbumDeleted::dispatch($parent_id);
+			}
+
 			return $file_deleter;
 			// @codeCoverageIgnoreStart
 		} catch (QueryBuilderException|InternalLycheeException $e) {

app/Actions/Album/SetProtectionPolicy.php

@@ -8,6 +8,7 @@
 
 namespace App\Actions\Album;
 
+use App\Events\AlbumSaved;
 use App\Exceptions\Internal\FrameworkException;
 use App\Exceptions\InvalidPropertyException;
 use App\Exceptions\ModelDBException;
@@ -34,10 +35,12 @@ public function do(BaseAlbum $album, AlbumProtectionPolicy $protection_policy, b
 		$album->save();
 
 		$active_permissions = $album->public_permissions();
-
 		if (!$protection_policy->is_public) {
 			$active_permissions?->delete();
 
+			// Just dispatch if something changed.
+			AlbumSaved::dispatch($album);
+
 			return;
 		}
 
@@ -62,5 +65,7 @@ public function do(BaseAlbum $album, AlbumProtectionPolicy $protection_policy, b
 		}
 		$active_permissions->base_album_id = $album->get_id();
 		$active_permissions->save();
+
+		AlbumSaved::dispatch($album);
 	}
 }

app/Actions/Albums/Flow.php

@@ -55,12 +55,6 @@ public function do(): AlbumBuilder
 			// In this specific case we want to know if an album is recursive NSFW.
 			// This will be used to determine if the album should be blurred.
 			$base_query->addVirtualIsRecursiveNSFW();
-
-			// Due to the way the virtual columns are added in AlbumBuilder::getModel(), we need to add them here.
-			$base_query->addVirtualMinTakenAt();
-			$base_query->addVirtualMaxTakenAt();
-			$base_query->addVirtualNumChildren();
-			$base_query->addVirtualNumPhotos();
 		}
 
 		// Apply the security policy to the query.

app/Actions/Photo/Delete.php

@@ -11,6 +11,7 @@
 use App\Actions\Shop\PurchasableService;
 use App\Constants\PhotoAlbum as PA;
 use App\Enum\SizeVariantType;
+use App\Events\PhotoDeleted;
 use App\Exceptions\Internal\LycheeAssertionError;
 use App\Exceptions\Internal\LycheeLogicException;
 use App\Exceptions\Internal\QueryBuilderException;
@@ -91,6 +92,9 @@ public function do(array $photo_ids, string|null $from_id, array $album_ids = []
 	{
 		$this->validateArguments($photo_ids, $from_id, $album_ids);
 
+		// Collect affected album IDs BEFORE deletion for event dispatching
+		$affected_album_ids = $this->collectAffectedAlbumIds($photo_ids, $from_id, $album_ids);
+
 		// First find out which photos do not have an album.
 		// Those will be deleted.
 		$unsorted_photo_ids = $this->collectUnsortedPhotos($photo_ids);
@@ -124,6 +128,11 @@ public function do(array $photo_ids, string|null $from_id, array $album_ids = []
 		// @codeCoverageIgnoreEnd
 		Album::query()->whereIn('header_id', $photo_ids)->update(['header_id' => null]);
 
+		// Dispatch events for affected albums to trigger recomputation
+		foreach ($affected_album_ids as $album_id) {
+			PhotoDeleted::dispatch($album_id);
+		}
+
 		return $this->file_deleter;
 	}
 
@@ -149,6 +158,32 @@ private function validateArguments(array $photo_ids, string|null $from_id, array
 		};
 	}
 
+	/**
+	 * Collect album IDs that will be affected by photo deletion.
+	 * This must be called BEFORE photos are deleted.
+	 *
+	 * @param string[]    $photo_ids
+	 * @param string|null $from_id
+	 * @param string[]    $album_ids
+	 *
+	 * @return string[] album IDs that need stats recomputation
+	 */
+	private function collectAffectedAlbumIds(array $photo_ids, string|null $from_id, array $album_ids): array
+	{
+		if (count($album_ids) > 0) {
+			// Deleting from specific albums
+			return $album_ids;
+		}
+
+		if (count($photo_ids) > 0 && $from_id !== null) {
+			// Deleting specific photos from a specific album
+			return [$from_id];
+		}
+
+		// No albums affected
+		return [];
+	}
+
 	/**
 	 * We select all photos which are not in an album and in the preselection.
 	 *

app/Actions/Photo/MoveOrDuplicate.php

@@ -12,6 +12,8 @@
 use App\Actions\User\Notify;
 use App\Constants\PhotoAlbum as PA;
 use App\Contracts\Models\AbstractAlbum;
+use App\Events\PhotoDeleted;
+use App\Events\PhotoSaved;
 use App\Models\Album;
 use App\Models\Photo;
 use App\Models\Purchasable;
@@ -50,6 +52,9 @@ public function do(Collection $photos, ?AbstractAlbum $from_album, ?Album $to_al
 				->delete();
 		}
 
+		// Dispatch event for source album (photos removed)
+		PhotoDeleted::dispatchIf($from_album !== null, $from_album?->get_id());
+
 		if ($to_album !== null) {
 			// Delete the existing links at destination (avoid duplicates key contraint)
 			// If $from === to this operation is not needed.
@@ -60,6 +65,12 @@ public function do(Collection $photos, ?AbstractAlbum $from_album, ?Album $to_al
 
 			// Add the new links.
 			DB::table(PA::PHOTO_ALBUM)->insert(array_map(fn (string $id) => ['photo_id' => $id, 'album_id' => $to_album->id], $photos_ids));
+
+			// Dispatch event for destination album (photos added)
+			// Note: We dispatch PhotoSaved for each photo to trigger recomputation
+			foreach ($photos as $photo) {
+				PhotoSaved::dispatch($photo);
+			}
 		}
 
 		// In case of move, we need to remove the header_id of said photos.

app/Actions/Photo/Pipes/Shared/Save.php

@@ -10,6 +10,7 @@
 
 use App\Contracts\PhotoCreate\PhotoDTO;
 use App\Contracts\PhotoCreate\PhotoPipe;
+use App\Events\PhotoSaved;
 
 /**
  * Persist current Photo object into database.
@@ -21,6 +22,9 @@ public function handle(PhotoDTO $state, \Closure $next): PhotoDTO
 		$state->getPhoto()->save();
 		$state->getPhoto()->tags()->sync($state->getTags()->pluck('id')->all());
 
+		// Dispatch event for album stats recomputation
+		PhotoSaved::dispatch($state->getPhoto());
+
 		return $next($state);
 	}
 }

app/Console/Commands/BackfillAlbumFields.php

@@ -0,0 +1,106 @@
+<?php
+
+/**
+ * SPDX-License-Identifier: MIT
+ * Copyright (c) 2017-2018 Tobias Reich
+ * Copyright (c) 2018-2025 LycheeOrg.
+ */
+
+namespace App\Console\Commands;
+
+use App\Jobs\RecomputeAlbumStatsJob;
+use App\Models\Album;
+use Illuminate\Console\Command;
+use Illuminate\Support\Facades\Log;
+
+class BackfillAlbumFields extends Command
+{
+	/**
+	 * The name and signature of the console command.
+	 *
+	 * @var string
+	 */
+	protected $signature = 'lychee:backfill-album-fields
+							{--dry-run : Preview without making changes}
+							{--chunk=1000 : Number of albums to process per batch}';
+
+	/**
+	 * The console command description.
+	 *
+	 * @var string
+	 */
+	protected $description = 'Backfill computed fields (min/max taken_at, num_children, num_photos, cover IDs) for all albums';
+
+	/**
+	 * Execute the console command.
+	 */
+	public function handle(): int
+	{
+		$dry_run = $this->option('dry-run');
+		$chunk_size = (int) $this->option('chunk');
+
+		if ($chunk_size < 1) {
+			$this->error('Chunk size must be at least 1');
+
+			return Command::FAILURE;
+		}
+
+		$this->info('Starting album fields backfill...');
+		if ($dry_run) {
+			$this->warn('DRY RUN MODE - No changes will be made');
+		}
+
+		// Get total count
+		$total = Album::query()->count();
+		$this->info("Found {$total} albums to process");
+
+		if ($total === 0) {
+			$this->info('No albums to process');
+
+			return Command::SUCCESS;
+		}
+
+		// Process albums ordered by _lft ASC (leaf-to-root order)
+		// This ensures child albums are computed before parents
+		$bar = $this->output->createProgressBar($total);
+		$bar->start();
+
+		$processed = 0;
+
+		Album::query()
+			->orderBy('_lft', 'asc')
+			->chunk($chunk_size, function (\Illuminate\Database\Eloquent\Collection $albums) use ($dry_run, &$processed, $bar): void {
+				/** @var Album $album */
+				foreach ($albums as $album) {
+					if (!$dry_run) {
+						// Dispatch job to recompute stats for this album
+						RecomputeAlbumStatsJob::dispatch($album->id);
+					}
+
+					$processed++;
+					$bar->advance();
+
+					// Log progress at intervals
+					if ($processed % 100 === 0) {
+						$percentage = round(($processed / $bar->getMaxSteps()) * 100, 2);
+						Log::info("Backfilled {$processed}/{$bar->getMaxSteps()} albums ({$percentage}%)");
+					}
+				}
+			});
+
+		$bar->finish();
+		$this->newLine(2);
+
+		if ($dry_run) {
+			$this->info("DRY RUN: Would have dispatched {$processed} jobs");
+		} else {
+			$this->info("Dispatched {$processed} jobs to recompute album stats");
+			$this->info('Jobs will be processed by the queue worker');
+			$this->warn('Note: This operation may take some time for large galleries');
+		}
+
+		Log::info("Backfill completed: {$processed} albums processed");
+
+		return Command::SUCCESS;
+	}
+}