feat: Add support for versioning asset

composer-dependency-analyser.php

@@ -31,6 +31,9 @@
     ->ignoreErrorsOnPackage('twig/twig', [
         ErrorType::DEV_DEPENDENCY_IN_PROD,
     ])
+    ->ignoreErrorsOnPackage('symfony/asset', [
+        ErrorType::DEV_DEPENDENCY_IN_PROD,
+    ])
 ;
 
 if (\PHP_VERSION_ID < 80200) { // TODO: Requires PHP >= 8.2

composer.json

@@ -23,6 +23,7 @@
     "require": {
         "php": ">=8.1",
         "ext-json": "*",
+        "ext-filter": "*",
         "psr/container": "^2.0",
         "psr/log": "^3.0",
         "symfony/config": "^6.4 || ^7.0 || ^8.0",
@@ -45,6 +46,7 @@
         "phpstan/phpstan-symfony": "^2.0",
         "phpunit/phpunit": "^10.5.46",
         "shipmonk/composer-dependency-analyser": "^1.8",
+        "symfony/asset": "^6.4 || ^7.0 || ^8.0",
         "symfony/error-handler": "^6.4 || ^7.0 || ^8.0",
         "symfony/framework-bundle": "^6.4 || ^7.0 || ^8.0",
         "symfony/http-client": "^6.4 || ^7.0 || ^8.0",

config/services.php

@@ -43,6 +43,7 @@
         ->tag('twig.extension')
     ;
     $services->set('sensiolabs_gotenberg.twig.asset_runtime', GotenbergRuntime::class)
+        ->args([service('assets.packages')->nullOnInvalid()])
         ->tag('twig.runtime')
     ;
 

src/DependencyInjection/Configuration.php

@@ -24,9 +24,12 @@ public function getConfigTreeBuilder(): TreeBuilder
         $treeBuilder->getRootNode()
             ->addDefaultsIfNotSet()
             ->children()
-                ->scalarNode('assets_directory')
+                ->arrayNode('assets_directory')
+                    ->normalizeKeys(false)
+                    ->prototype('scalar')->end()
                     ->info('Base directory will be used for assets, files, markdown')
-                    ->defaultValue('%kernel.project_dir%/assets')
+                    ->defaultValue(['%kernel.project_dir%/assets'])
+                    ->beforeNormalization()->castToArray()->end()
                 ->end()
                 ->scalarNode('version')
                     ->info('Version of Gotenberg')

src/Formatter/AssetBaseDirFormatter.php

@@ -2,32 +2,53 @@
 
 namespace Sensiolabs\GotenbergBundle\Formatter;
 
+use Symfony\Component\Filesystem\Exception\FileNotFoundException;
 use Symfony\Component\Filesystem\Path;
 
 /**
  * @internal
  */
 final class AssetBaseDirFormatter
 {
-    private readonly string $baseDir;
+    /** @var string[] */
+    private readonly array $baseDir;
 
+    /** @var array<string, string> */
+    private array $resolvedPathsCache = [];
+
+    /**
+     * @param string[] $baseDir
+     */
     public function __construct(
         private readonly string $projectDir,
-        string $baseDir,
+        array $baseDir,
     ) {
-        $this->baseDir = rtrim($baseDir, '/\\');
+        $this->baseDir = array_map(static fn ($value) => rtrim($value, '/\\'), $baseDir);
     }
 
     public function resolve(string $path): string
     {
-        if (Path::isAbsolute($path)) {
-            return $path;
+        if (\array_key_exists($path, $this->resolvedPathsCache)) {
+            return $this->resolvedPathsCache[$path];
+        }
+
+        if (Path::isAbsolute($path) || filter_var($path, \FILTER_VALIDATE_URL)) {
+            return $this->resolvedPathsCache[$path] = $path;
         }
 
-        if (Path::isAbsolute($this->baseDir)) {
-            return Path::join($this->baseDir, $path);
+        foreach ($this->baseDir as $baseDir) {
+            if (!Path::isAbsolute($baseDir)) {
+                $baseDir = Path::join($this->projectDir, $baseDir);
+            }
+
+            $filename = Path::join($baseDir, $path);
+            if (!file_exists($filename)) {
+                continue;
+            }
+
+            return $this->resolvedPathsCache[$path] = $filename;
         }
 
-        return Path::join($this->projectDir, $this->baseDir, $path);
+        throw new FileNotFoundException(\sprintf('File "%s" not found in assets directories: "%s".', $path, implode('", "', $this->baseDir)));
     }
 }

src/Test/Builder/GotenbergBuilderTestCase.php

@@ -33,7 +33,7 @@ protected function setUp(): void
         $this->client = new GotenbergClientAsserter();
         $this->container = new Container();
 
-        $this->container->set('asset_base_dir_formatter', new AssetBaseDirFormatter(static::FIXTURE_DIR, static::FIXTURE_DIR));
+        $this->container->set('asset_base_dir_formatter', new AssetBaseDirFormatter(static::FIXTURE_DIR, [static::FIXTURE_DIR]));
         $this->container->set('sensiolabs_gotenberg.client', $this->client);
         $this->container->set('sensiolabs_gotenberg.version_fetcher', new StaticVersionFetcher($this->gotenbergVersion));
     }

src/Twig/GotenbergRuntime.php

@@ -3,6 +3,7 @@
 namespace Sensiolabs\GotenbergBundle\Twig;
 
 use Sensiolabs\GotenbergBundle\Builder\BuilderAssetInterface;
+use Symfony\Component\Asset\Packages;
 
 /**
  * @internal
@@ -14,6 +15,10 @@ final class GotenbergRuntime
 {
     private BuilderAssetInterface|null $builder = null;
 
+    public function __construct(private readonly Packages|null $packages = null)
+    {
+    }
+
     public function setBuilder(BuilderAssetInterface|null $builder): void
     {
         $this->builder = $builder;
@@ -27,20 +32,23 @@ public function setBuilder(BuilderAssetInterface|null $builder): void
      */
     public function getAssetUrl(string $path): string
     {
+        $path = $this->getVersionedPathIfExist($path);
         $this->addAsset($path, 'gotenberg_asset');
 
         return basename($path);
     }
 
     public function getFontStyleTag(string $path, string $name): string
     {
+        $path = $this->getVersionedPathIfExist($path);
         $this->addAsset($path, 'gotenberg_font_style_tag');
 
         return '<style>'.$this->generateFontFace($path, $name).'</style>';
     }
 
     public function getFontFace(string $path, string $name): string
     {
+        $path = $this->getVersionedPathIfExist($path);
         $this->addAsset($path, 'gotenberg_font_face');
 
         return $this->generateFontFace($path, $name);
@@ -62,4 +70,14 @@ private function addAsset(string $path, string $function): void
 
         $this->builder->addAsset($path);
     }
+
+    private function getVersionedPathIfExist(string $path): string
+    {
+        $packages = $this->packages;
+        if (null !== $packages) {
+            $path = ltrim($packages->getUrl($path), '/');
+        }
+
+        return $path;
+    }
 }

tests/Builder/Pdf/ConvertPdfBuilderTest.php

@@ -100,7 +100,7 @@ public function testFilesExtensionRequirement(): void
         $this->expectExceptionMessage('The file extension "png" is not valid in this context.');
 
         $this->getBuilder()
-            ->files('b.png')
+            ->files(self::FIXTURE_DIR.'/assets/logo.png')
             ->generate()
         ;
     }

tests/Builder/Pdf/FlattenPdfBuilderTest.php

@@ -54,7 +54,7 @@ public function testFilesExtensionRequirement(): void
         $this->expectExceptionMessage('The file extension "png" is not valid in this context.');
 
         $this->getBuilder()
-            ->files('b.png')
+            ->files(self::FIXTURE_DIR.'/assets/logo.png')
             ->generate()
         ;
     }

tests/Builder/Pdf/HtmlPdfBuilderTest.php

@@ -50,7 +50,7 @@ public function testRequiredFormData(): void
 
     public function testOutputFilename(): void
     {
-        $this->container->set('asset_base_dir_formatter', new AssetBaseDirFormatter(self::FIXTURE_DIR, self::FIXTURE_DIR));
+        $this->container->set('asset_base_dir_formatter', new AssetBaseDirFormatter(self::FIXTURE_DIR, [self::FIXTURE_DIR]));
 
         $this->getBuilder()
             ->contentFile('files/content.html')
@@ -64,7 +64,7 @@ public function testOutputFilename(): void
 
     public function testWidth(): void
     {
-        $this->container->set('asset_base_dir_formatter', new AssetBaseDirFormatter(self::FIXTURE_DIR, self::FIXTURE_DIR));
+        $this->container->set('asset_base_dir_formatter', new AssetBaseDirFormatter(self::FIXTURE_DIR, [self::FIXTURE_DIR]));
 
         $this->getBuilder()
             ->contentFile('files/content.html')
@@ -83,7 +83,7 @@ public function testWidth(): void
 
     public function testWithTwigContentFile(): void
     {
-        $this->container->set('asset_base_dir_formatter', new AssetBaseDirFormatter(self::FIXTURE_DIR, self::FIXTURE_DIR));
+        $this->container->set('asset_base_dir_formatter', new AssetBaseDirFormatter(self::FIXTURE_DIR, [self::FIXTURE_DIR]));
 
         $twig = new Environment(new FilesystemLoader(self::FIXTURE_DIR), [
             'strict_variables' => true,
@@ -123,7 +123,7 @@ public function load(string $class): object|null
 
     public function testWithTwigAndHeaderFooterParts(): void
     {
-        $this->container->set('asset_base_dir_formatter', new AssetBaseDirFormatter(self::FIXTURE_DIR, self::FIXTURE_DIR));
+        $this->container->set('asset_base_dir_formatter', new AssetBaseDirFormatter(self::FIXTURE_DIR, [self::FIXTURE_DIR]));
 
         $twig = new Environment(new FilesystemLoader(self::FIXTURE_DIR), [
             'strict_variables' => true,
@@ -195,7 +195,7 @@ public function load(string $class): object|null
 
     public function testFilesAsHeaderAndFooter(): void
     {
-        $this->container->set('asset_base_dir_formatter', new AssetBaseDirFormatter(self::FIXTURE_DIR, self::FIXTURE_DIR));
+        $this->container->set('asset_base_dir_formatter', new AssetBaseDirFormatter(self::FIXTURE_DIR, [self::FIXTURE_DIR]));
 
         $this->getBuilder()
             ->headerFile('files/header.html')
@@ -217,7 +217,7 @@ public function testWithInvalidTwigTemplate(): void
     {
         $this->expectException(PartRenderingException::class);
 
-        $this->container->set('asset_base_dir_formatter', new AssetBaseDirFormatter(self::FIXTURE_DIR, self::FIXTURE_DIR));
+        $this->container->set('asset_base_dir_formatter', new AssetBaseDirFormatter(self::FIXTURE_DIR, [self::FIXTURE_DIR]));
 
         $twig = new Environment(new FilesystemLoader(self::FIXTURE_DIR), [
             'strict_variables' => true,

tests/Builder/Pdf/MarkdownPdfBuilderTest.php

@@ -121,7 +121,7 @@ public function testFilesExtensionRequirement(): void
         $this->expectExceptionMessage('The file extension "png" is not valid in this context.');
 
         $this->getBuilder()
-            ->files('b.png')
+            ->files(self::FIXTURE_DIR.'/assets/logo.png')
             ->generate()
         ;
     }

tests/Builder/Pdf/MergePdfBuilderTest.php

@@ -86,7 +86,7 @@ public function testFilesExtensionRequirement(): void
         $this->expectExceptionMessage('The file extension "png" is not valid in this context.');
 
         $this->getBuilder()
-            ->files('simple_pdf.pdf', 'b.png')
+            ->files(self::FIXTURE_DIR.'/assets/logo.png')
             ->generate()
         ;
     }

tests/Builder/Pdf/SplitPdfBuilderTest.php

@@ -95,7 +95,7 @@ public function testFilesExtensionRequirement(): void
         $this->expectExceptionMessage('The file extension "png" is not valid in this context.');
 
         $this->getBuilder()
-            ->files('b.png')
+            ->files(self::FIXTURE_DIR.'/assets/logo.png')
             ->splitMode(SplitMode::Pages)
             ->splitSpan('1-2')
             ->generate()

tests/Builder/Screenshot/HtmlScreenshotBuilderTest.php

@@ -39,7 +39,7 @@ protected function initializeBuilder(BuilderInterface $builder, Container $conta
 
     public function testOutputFilename(): void
     {
-        $this->container->set('asset_base_dir_formatter', new AssetBaseDirFormatter(self::FIXTURE_DIR, self::FIXTURE_DIR));
+        $this->container->set('asset_base_dir_formatter', new AssetBaseDirFormatter(self::FIXTURE_DIR, [self::FIXTURE_DIR]));
 
         $this->getBuilder()
             ->contentFile('files/content.html')

tests/Builder/Screenshot/MarkdownScreenshotBuilderTest.php

@@ -41,7 +41,7 @@ protected function initializeBuilder(BuilderInterface $builder, Container $conta
 
     public function testOutputFilename(): void
     {
-        $this->container->set('asset_base_dir_formatter', new AssetBaseDirFormatter(self::FIXTURE_DIR, self::FIXTURE_DIR));
+        $this->container->set('asset_base_dir_formatter', new AssetBaseDirFormatter(self::FIXTURE_DIR, [self::FIXTURE_DIR]));
 
         $this->getBuilder()
             ->wrapperFile('files/content.html')
@@ -137,7 +137,7 @@ public function testFilesExtensionRequirement(): void
         $this->expectExceptionMessage('The file extension "png" is not valid in this context.');
 
         $this->getBuilder()
-            ->files('b.png')
+            ->files(self::FIXTURE_DIR.'/assets/logo.png')
             ->generate()
         ;
     }

tests/DependencyInjection/ConfigurationTest.php

@@ -216,7 +216,7 @@ public function testInvalidWebhookConfiguration(array $config): void
 
     /**
      * @return array{
-     *     'assets_directory': string,
+     *     'assets_directory': string[],
      *     'http_client': string,
      *     'webhook': array<void>,
      *     'default_options': array{
@@ -235,7 +235,7 @@ private static function getBundleDefaultConfig(): array
     {
         return [
             'version' => null,
-            'assets_directory' => '%kernel.project_dir%/assets',
+            'assets_directory' => ['%kernel.project_dir%/assets'],
             'http_client' => 'http_client',
             'webhook' => [],
             'controller_listener' => true,

tests/Formatter/AssetBaseDirFormatterTest.php

@@ -9,23 +9,36 @@
 
 final class AssetBaseDirFormatterTest extends TestCase
 {
+    private const PROJECT_DIR = __DIR__.'/../';
+
     /**
-     * @return iterable<string, array<int, string>>
+     * @return iterable<string, array<int, list<string>|string>>
      */
     public static function generateBaseDirectoryAndPath(): iterable
     {
-        yield 'absolute path and absolute base dir' => ['/mock/foo/file.md', '/mock/bar', '/mock/foo/file.md'];
-        yield 'absolute path and relative base dir' => ['/mock/foo/logo.png', '/bar', '/mock/foo/logo.png'];
-        yield 'relative path and relative base dir' => ['document.odt', 'bar/baz', '/mock/bar/baz/document.odt'];
-        yield 'relative path and absolute base dir' => ['foo/document.odt', '/mock/bar/baz', '/mock/bar/baz/foo/document.odt'];
-        yield 'relative path and relative base dir with end slash' => ['document.odt', 'bar/baz/', '/mock/bar/baz/document.odt'];
+        $projectDir = \dirname(self::PROJECT_DIR, 2);
+
+        yield 'absolute path and absolute base dir' => [$projectDir.'/Fixtures/assets/file.md', [$projectDir.'/Fixtures/assets'], $projectDir.'/Fixtures/assets/file.md'];
+        yield 'absolute path and relative base dir' => [$projectDir.'/Fixtures/assets/file.md', ['assets'], $projectDir.'/Fixtures/assets/file.md'];
+        yield 'relative path and relative base dir' => ['file.md', ['Fixtures/assets'], $projectDir.'/Fixtures/assets/file.md'];
+        yield 'relative path and absolute base dir' => ['office/document.odt', [$projectDir.'/Fixtures/assets'], $projectDir.'/Fixtures/assets/office/document.odt'];
+        yield 'relative path and relative base dir with end slash' => ['document.odt', ['Fixtures/assets/office/'], $projectDir.'/Fixtures/assets/office/document.odt'];
+        yield 'URL path and absolute base dir' => ['https://sensiolabs.com/assets/images/sensiolabs/sensiolabs.fr-OAnPSf0.png', [$projectDir.'/Fixtures/assets'], 'https://sensiolabs.com/assets/images/sensiolabs/sensiolabs.fr-OAnPSf0.png'];
+        yield 'URL path and relative base dir' => ['https://sensiolabs.com/assets/images/sensiolabs/sensiolabs.fr-OAnPSf0.png', ['assets'], 'https://sensiolabs.com/assets/images/sensiolabs/sensiolabs.fr-OAnPSf0.png'];
+        yield 'absolute path and two absolute base dir' => [$projectDir.'/Fixtures/assets/office/document.odt', [$projectDir.'/Fixtures/assets', $projectDir.'/Fixtures/assets/office'], $projectDir.'/Fixtures/assets/office/document.odt'];
+        yield 'absolute path and two relative base dir' => [$projectDir.'/Fixtures/assets/office/document.odt', ['Fixtures/assets', 'Fixtures/assets/office'], $projectDir.'/Fixtures/assets/office/document.odt'];
+        yield 'relative path and two absolute base dir' => ['document.odt', [$projectDir.'/Fixtures/assets', $projectDir.'/Fixtures/assets/office'], $projectDir.'/Fixtures/assets/office/document.odt'];
+        yield 'relative path and two relative base dir' => ['document.odt', ['Fixtures/assets', 'Fixtures/assets/office'], $projectDir.'/Fixtures/assets/office/document.odt'];
     }
 
+    /**
+     * @param string[] $baseDirectories
+     */
     #[DataProvider('generateBaseDirectoryAndPath')]
     #[TestDox('Resolve path when "$_dataName"')]
-    public function testResolvePathCorrectly(string $path, string $baseDirectory, string $expectedResult): void
+    public function testResolvePathCorrectly(string $path, array $baseDirectories, string $expectedResult): void
     {
-        $assetBaseDirFormatter = new AssetBaseDirFormatter('/mock', $baseDirectory);
+        $assetBaseDirFormatter = new AssetBaseDirFormatter(self::PROJECT_DIR, $baseDirectories);
         $resolvedPath = $assetBaseDirFormatter->resolve($path);
         self::assertSame($expectedResult, $resolvedPath);
     }