Add AssetMapper support

.github/workflows/phpstan.yml

@@ -26,5 +26,8 @@ jobs:
       - name: Add vips
         run: composer require rokka/imagine-vips
 
+      - name: Add asset mapper
+        run: composer require symfony/asset-mapper
+
       - name: Run PHPStan
         run: vendor/bin/phpstan analyze

Binary/Locator/AssetMapperLocator.php

@@ -0,0 +1,86 @@
+<?php
+
+/*
+ * This file is part of the `liip/LiipImagineBundle` project.
+ *
+ * (c) https://github.com/liip/LiipImagineBundle/graphs/contributors
+ *
+ * For the full copyright and license information, please view the LICENSE.md
+ * file that was distributed with this source code.
+ */
+
+namespace Liip\ImagineBundle\Binary\Locator;
+
+use Liip\ImagineBundle\Exception\Binary\Loader\NotLoadableException;
+use Symfony\Component\AssetMapper\AssetMapperInterface;
+use Psr\Cache\CacheItemPoolInterface;
+
+/**
+ * Class responsible for locating assets in the asset mapper.
+ * Implements the LocatorInterface to resolve asset paths.
+ * This Class should be used only in dev environment.
+ */
+class AssetMapperLocator implements LocatorInterface
+{
+
+	private $assetMapper;
+	private $cacheMapCache = null;
+
+	public function __construct(
+		AssetMapperInterface $assetMapper,
+		?CacheItemPoolInterface $cacheMapCache = null
+	) {
+		$this->cacheMapCache = $cacheMapCache;
+		$this->assetMapper   = $assetMapper;
+	}
+
+	/**
+	 * Locates an asset by its public path.
+	 *
+	 * This method attempts to retrieve an asset using its public path. It first
+	 * checks for a cached version of the asset, and if none is found, it iterates
+	 * through all available assets to find a match. If no matching asset is located,
+	 * an exception is thrown.
+	 *
+	 * Inspired by Symfony's AssetMapper component @see https://github.com/symfony/asset-mapper/blob/7.3/AssetMapperDevServerSubscriber.php#L179.
+	 *
+	 * @param string $path The public path of the asset to locate.
+	 *
+	 * @return string The located asset.
+	 *
+	 * @throws NotLoadableException If no asset with the specified public path is found.
+	 */
+	public function locate(string $path): string
+	{
+		$pathInfo = '/'.ltrim($path, '/');
+		$cachedAsset = null;
+		if (null !== $this->cacheMapCache) {
+			$cachedAsset = $this->cacheMapCache->getItem(hash('xxh128', $pathInfo));
+			$asset = $cachedAsset->isHit() ? $this->assetMapper->getAsset($cachedAsset->get()) : null;
+
+			if (null !== $asset && $asset->publicPath === $pathInfo) {
+				return $asset;
+			}
+		}
+
+		// we did not find a match
+		$asset = null;
+		foreach ($this->assetMapper->allAssets() as $assetCandidate) {
+			if ($pathInfo === $assetCandidate->publicPath) {
+				$asset = $assetCandidate;
+				break;
+			}
+		}
+
+		if (null === $asset) {
+			throw new NotLoadableException(\sprintf('Asset with public path "%s" not found.', $path));
+		}
+
+		if (null !== $cachedAsset) {
+			$cachedAsset->set($asset->logicalPath);
+			$this->cacheMapCache->save($cachedAsset);
+		}
+
+		return $asset;
+	}
+}

DependencyInjection/Factory/Loader/AssetMapperLoaderFactory.php

@@ -0,0 +1,50 @@
+<?php
+
+/*
+ * This file is part of the `liip/LiipImagineBundle` project.
+ *
+ * (c) https://github.com/liip/LiipImagineBundle/graphs/contributors
+ *
+ * For the full copyright and license information, please view the LICENSE.md
+ * file that was distributed with this source code.
+ */
+
+namespace Liip\ImagineBundle\DependencyInjection\Factory\Loader;
+
+use Symfony\Component\Config\Definition\Builder\ArrayNodeDefinition;
+use Symfony\Component\DependencyInjection\ChildDefinition;
+use Symfony\Component\DependencyInjection\ContainerBuilder;
+use Symfony\Component\DependencyInjection\Reference;
+
+class AssetMapperLoaderFactory extends AbstractLoaderFactory
+{
+	public function create(ContainerBuilder $container, $loaderName, array $config)
+	{
+		$locatorDefinition = new ChildDefinition('liip_imagine.binary.locator.asset_mapper');
+		$locatorDefinition->replaceArgument(0, new Reference('asset_mapper'));
+		$locatorDefinition->replaceArgument(1, new Reference('cache.asset_mapper'));
+
+		$definition = $this->getChildLoaderDefinition('filesystem');
+
+		if ($container->hasDefinition('liip_imagine.mime_types')) {
+			$mimeTypes = $container->getDefinition('liip_imagine.mime_types');
+			$definition->replaceArgument(0, $mimeTypes);
+			$definition->replaceArgument(1, $mimeTypes);
+		}
+		$definition->replaceArgument(2, $locatorDefinition);
+
+		return $this->setTaggedLoaderDefinition($loaderName, $definition, $container);
+	}
+
+	public function getName()
+	{
+		return 'asset_mapper';
+	}
+
+	public function addConfiguration(ArrayNodeDefinition $builder)
+	{
+		$builder
+			->children()
+			->end();
+	}
+}

LiipImagineBundle.php

@@ -23,6 +23,7 @@
 use Liip\ImagineBundle\DependencyInjection\Compiler\NonFunctionalFilterExceptionPass;
 use Liip\ImagineBundle\DependencyInjection\Compiler\PostProcessorsCompilerPass;
 use Liip\ImagineBundle\DependencyInjection\Compiler\ResolversCompilerPass;
+use Liip\ImagineBundle\DependencyInjection\Factory\Loader\AssetMapperLoaderFactory;
 use Liip\ImagineBundle\DependencyInjection\Factory\Loader\ChainLoaderFactory;
 use Liip\ImagineBundle\DependencyInjection\Factory\Loader\FileSystemLoaderFactory;
 use Liip\ImagineBundle\DependencyInjection\Factory\Loader\FlysystemLoaderFactory;
@@ -69,6 +70,7 @@ public function build(ContainerBuilder $container): void
         $extension->addLoaderFactory(new StreamLoaderFactory());
         $extension->addLoaderFactory(new FileSystemLoaderFactory());
         $extension->addLoaderFactory(new FlysystemLoaderFactory());
+        $extension->addLoaderFactory(new AssetMapperLoaderFactory());
         $extension->addLoaderFactory(new ChainLoaderFactory());
 
         $container->registerForAutoconfiguration(LoaderLoaderInterface::class)->addTag('liip_imagine.filter.loader');